Skip to content

Capture Copilot Soul

POST
/copilot/memory/soul-capture

Set the organisation’s and the user’s foundational documents in one call.

The onboarding shortcut: it is how a new workspace tells the assistant who it works for before there is any history to learn from. Every field is optional and sending one does not clear the others.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirror of SoulCaptureRequest.

Every field optional: this is used to fill in whichever of the three documents the caller has, and sending one does not clear the others.

object
org_memory
Any of:
string
org_soul
Any of:
string
user_memory
Any of:
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