Skip to main content

ClientContext

Opaque caller-supplied attributes attached to a conversation message.

Values are strings, including values such as "false". The schema allows at most 32 pairs, keys of at most 64 characters, and values of at most 1,024 characters. Keep the entire map well below 8 KiB: Travila also applies an encoded-size limit that includes field overhead and drops context that exceeds it. Short page identifiers and a few relevant values are preferable to a page dump; an oversized map is not automatically shortened.

Usage profiles​

UsageFields and validation
In requestsView fields
In responsesView fields
In webhook payloadsView fields

In requests​

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
valuesMap from string to stringOptionalArbitrary client-supplied context for this message (e.g. page, referrer, device, in-app flow). Keys/values are opaque strings. Maximum properties: 32.

Request validation​

These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.

Applies toRuleRequirement
valuesMax Pairs32
valuesKeys · Maximum length64
valuesValues · Maximum length1024

In responses​

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
valuesMap from string to stringOptionalArbitrary client-supplied context for this message (e.g. page, referrer, device, in-app flow). Keys/values are opaque strings.

Request validation​

These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.

Applies toRuleRequirement
valuesMax Pairs32
valuesKeys · Maximum length64
valuesValues · Maximum length1024

In webhook payloads​

Webhook JSON uses protobuf field names (snake_case).

FieldTypePresenceMeaning
valuesMap from string to stringOptionalArbitrary client-supplied context for this message (e.g. page, referrer, device, in-app flow). Keys/values are opaque strings.

Request validation​

These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.

Applies toRuleRequirement
valuesMax Pairs32
valuesKeys · Maximum length64
valuesValues · Maximum length1024

Where used​

ReferenceRelationship
Append a message without generatingPOST /api/v1/llm/append-message
Send a message to a conversationPOST /api/v1/llm/send-message
Send a message and wait for the resultPOST /api/v1/llm/send-message-sync
Withdraw your rating on a messagePOST /api/v1/llm/delete-message-rating
Get full conversation statePOST /api/v1/llm/conversation-state
Rate an assistant messagePOST /api/v1/llm/rate-message
Submit client-side tool results and wait for the next segmentPOST /api/v1/llm/submit-client-tool-results-sync
llm.message_publishedWebhook JSON uses protobuf field names (snake_case).
MessageNested in model
MessageNested in model
MessageNested in model

Download the public reference contract.

Document: DOC-API-MODEL-client-context.