Skip to content

Get Copilot Memory Documents

GET
/copilot/memory/documents

The raw memory documents for one subject.

soul is who they are, memory is durable fact, daily is the rolling journal. GET /copilot/memory/context is the assembled view; this is the source behind it, and the thing to edit.

Authorizations

Parameters

Query Parameters

subject_type
required

Organization | user | campaign | company | contact.

string

Organization | user | campaign | company | contact.

subject_id
required

Which one.

string

Which one.

file_kind
Any of:
string

soul, memory or daily. Omit for all three - they are different documents, not versions of one.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a LIST answer, so a bare list keeps its shape.

object
items
Array
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