Skip to main content
POST
Python

Authorizations

Authorization
string
header
required

nia_sk_...

Body

application/json

Pass exactly one of subject or object, and conversation_id or task_id, not both.

about
Handle · object | null

The account or partner the person acts for.

conversation_id
string | null

Pins the pack to the conversation: the same bytes on every turn.

Required string length: 1 - 512
delta
boolean
default:false

Return only what changed since this source last read this customer.

known_etag
string | null

The ETag you already hold. If unchanged, the answer is not_modified: true with no text.

object
ObjectRef · object | null

Center the pack on an order, ticket or invoice.

query
string | null

What the customer or task is about, when known. Guides selection.

Maximum string length: 2000
subject
Handle · object | null

Who the context is about. Pass subject or object, exactly one.

target
TargetModel · object | null

The LLM that will read the pack; lets the compiler aim at its cache floor.

task_id
string | null

For internal agents, instead of conversation_id.

Required string length: 1 - 512
verification
enum<string>
default:V0

The level you request. The effective level is the lowest of this, the source ceiling and what the conversation proved.

Available options:
V0,
V1,
V2,
V3,
V4,
no_customer
view
string
default:chat
Pattern: ^(voice|chat|brief|full|custom|account|partner|task:[a-z0-9_]{1,40})$

Response

The pack, or not_modified: true when known_etag still matches.

etag
string
required
path
enum<string>
required

Which read tier answered a context() call.

Available options:
t0,
t1,
t2,
t3,
t4,
holdout,
not_modified
verification
VerificationResult · object
required
version
string
required

Context Pack spec version.

as_of
string<date-time> | null

The pack reflects events up to this instant.

cache
CacheDirectives · object | null
coverage
SourceCoverage · object[]
degraded
boolean
default:false
delta
string | null

What changed since your last read, when delta was requested.

lag_seconds
number | null
live
LiveTurn · object[]
live_complete
boolean
default:true
manifest_hash
string | null

Hash of the provenance manifest behind this pack. The receipt points to it.

not_modified
boolean
default:false
text
string | null

The Context Pack, ready for the prompt.

timing
Timing · object

Milliseconds per step.

variables
Variables · object

The same content as named variables, for templates.

withheld
integer
default:0

Items the policy held back at this verification level. Verifying releases more.