Skip to content

Upsert Copilot Memory Document

PUT
/copilot/memory/documents

Write a memory document WHOLE. This replaces, it does not merge.

visibility defaults to shared, which means the whole organisation’s Copilot may draw on it. That is the app’s default and it is the wider of the two, so it is what you get by not thinking about it - worth thinking about it.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirror of MemoryDocumentRequest.

object
content
required

The WHOLE document. This is an upsert, not an append: it replaces what is there. Use POST /copilot/memory/documents/append to add without replacing.

string
file_kind
required

soul - who the subject is. memory - durable facts. daily - the rolling journal.

string
subject_id
required

Which one.

string
subject_type
required

Organization | user | campaign | company | contact.

string
title
Any of:
string
visibility

shared - the whole org’s Copilot may draw on it. Defaults to shared, matching the app, so a document written without thinking about this is visible org-wide.

string
default: shared

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