Skip to main content
POST
Create context snapshot

Authorizations

Authorization
string
header
required

A workspace API key.

Headers

idempotency-key
string
required

Required stable id for this logical write; reuse it after a timeout. Upload endpoints also require the same value in body.idempotencyKey.

Required string length: 1 - 255

Body

application/json
scope
object
required

Scope shared by every source in the snapshot.

projectId
string
required

Authorized project the snapshot may support.

Required string length: 1 - 200
purpose
string
required

Specific task or decision this frozen context will support.

Required string length: 1 - 4000
audience
string
required

Intended readers or downstream consumers of the resulting work.

Required string length: 1 - 1000
sources
object[]
required

At least one authorized, version-pinned source to freeze.

Required array length: 1 - 500 elements
policyVersion
string
required

Policy version evaluated when the snapshot was frozen.

Required string length: 1 - 200
retentionMode
enum<string>
required

How much snapshot material may be retained after use.

Available options:
artifacts_only,
snapshot_metadata,
full_with_consent
schemaVersion
string

Optional contract version; the server always persists context-snapshot.v1.

Allowed value: "context-snapshot.v1"
retrievedPassages
object[]

Optional cited passage references selected from the frozen sources. Defaults to none.

Maximum array length: 5000
exclusions
object[]

Optional audit trail of candidate sources intentionally excluded. Defaults to none.

Maximum array length: 500

Response

Success.

success
boolean
required
contextSnapshot
object
required
{key}
any