DOC-API-MODEL-schema-1i2sndrl93#overview
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.
Type-reference view: API Schema 9frhv4euve, API Schema 9ftjkkjhfa. Request and response views describe this type; they do not declare an endpoint.
Meaning and usage
Section ID: DOC-API-MODEL-schema-1i2sndrl93#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1i2sndrl93#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-1i2sndrl93#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1i2sndrl93#request-field-valuesvalues | Map from string to string | Optional | Arbitrary client-supplied context for this message (e.g. page, referrer, device, in-app flow). Keys/values are opaque strings. Maximum properties: 32. |
Request validation
Section ID: DOC-API-MODEL-schema-1i2sndrl93#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 to | Rule | Requirement |
|---|---|---|
values | Max Pairs | 32 |
values | Keys · Maximum length | 64 |
values | Values · Maximum length | 1024 |
In responses
Section ID: DOC-API-MODEL-schema-1i2sndrl93#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1i2sndrl93#field-valuesSection ID: DOC-API-MODEL-schema-1i2sndrl93#response-field-valuesvalues | Map from string to string | Optional | Arbitrary client-supplied context for this message (e.g. page, referrer, device, in-app flow). Keys/values are opaque strings. |
DOC-API-MODEL-schema-1i2sndrl93#validation
Request validation
Section ID: DOC-API-MODEL-schema-1i2sndrl93#response-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 to | Rule | Requirement |
|---|---|---|
values | Max Pairs | 32 |
values | Keys · Maximum length | 64 |
values | Values · Maximum length | 1024 |
Where used
Section ID: DOC-API-MODEL-schema-1i2sndrl93#where-used
| Reference | Relationship |
|---|---|
| Withdraw your rating on a message | POST /api/v1/llm/delete-message-rating |
| Get full conversation state | POST /api/v1/llm/conversation-state |
| Rate an assistant message | POST /api/v1/llm/rate-message |
| Send a message and wait for the result | POST /api/v1/llm/send-message-sync |
| Submit client-side tool results and wait for the next segment | POST /api/v1/llm/submit-client-tool-results-sync |
| Append a message without generating | POST /api/v1/llm/append-message |
| Send a message to a conversation | POST /api/v1/llm/send-message |
| ReceiveMessageRequest | API JSON uses JSON field names (camelCase). |
| ClientToolDispatch | API JSON uses JSON field names (camelCase). |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1i2sndrl93