Skip to content

Promote Copilot Memory

POST
/copilot/memory/promote

Promote what is worth keeping out of the daily journal into durable memory.

The garbage-collection step of the whole memory design. Without it the journal grows without bound and the durable documents stay empty, so the assistant ends up with a great deal of noise and very little knowledge.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirror of PromoteRequest.

object
days_back

How far back through the daily journal to look for things worth keeping. Promotion is what stops the journal growing forever and the durable memory staying empty.

integer
default: 7
subject_id
required

Which one.

string
subject_type
required

Organization | user | campaign | company | contact.

string

Responses

200

Successful Response

object
data
required

An open envelope for one memory, wiki or sharing answer.

Open because the personal wiki is a DOCUMENT whose sections follow what has been learned about a person, and because each fact carries provenance - which mailbox or meeting it came from - that grows as new sources are connected. Pinning the shape would silently drop the provenance on the newest source, and on a “what do you know about me” surface a fact with no visible origin is worse than no fact.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string