Skip to main content
POST
Prepare current context or safely rebootstrap a prior capsule

Authorizations

Authorization
string
header
required

OrgX API key, sent as Authorization: Bearer oxk_...

Headers

Idempotency-Key
string

Accepted for forward compatibility. Replay safety for this operation comes from its own state checks, described on the operation.

Required string length: 1 - 200
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:/-]{0,199}$

Body

application/json
workspace_id
string<uuid>
required
initiative_id
string<uuid>
workstream_id
string<uuid>
task_id
string<uuid>
acknowledged_capsule_id
string
Pattern: ^capsule_[0-9a-f]{24}$
response_profile
enum<string>
default:full

Prepared returns one scoped capsule with an 8 KiB serialized data bound. Oversized output fails explicitly. Use the full profile for delta transfer.

Available options:
full,
prepared
delivery_mode
enum<string>
Available options:
full,
delta
acknowledged_context_version
string
Pattern: ^sha256:[a-f0-9]{64}$
reader_tokenizer
enum<string>
Available options:
o200k_base,
cl100k_base
max_payload_tokens
integer

Requires reader_tokenizer. Oversized required context fails explicitly.

Required range: x >= 1

Response

Full context or an opt-in transport delta; absent guarantees remain unknown

ok
enum<boolean>
required
Available options:
true
data
object
required