PromptTokensDetails
Breakdown of prompt token usage by category (input-side cache accounting)
Usage profiles
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
| In webhook payloads | View fields |
In requests
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
cachedTokens | integer (int32) | Optional | Prompt tokens served from cache (cache READ). Minimum: -2147483648. Maximum: 2147483647. |
cacheWriteTokens | integer (int32) | Optional | Prompt tokens written to cache this call (cache WRITE). Minimum: -2147483648. Maximum: 2147483647. |
audioTokens | integer (int32) | Optional | Prompt tokens from audio input (multimodal). Minimum: -2147483648. Maximum: 2147483647. |
videoTokens | integer (int32) | Optional | Prompt tokens from video input (multimodal). Minimum: -2147483648. Maximum: 2147483647. |
In responses
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
cachedTokens | integer (int32) | Optional | Prompt tokens served from cache (cache READ). Minimum: -2147483648. Maximum: 2147483647. |
cacheWriteTokens | integer (int32) | Optional | Prompt tokens written to cache this call (cache WRITE). Minimum: -2147483648. Maximum: 2147483647. |
audioTokens | integer (int32) | Optional | Prompt tokens from audio input (multimodal). Minimum: -2147483648. Maximum: 2147483647. |
videoTokens | integer (int32) | Optional | Prompt tokens from video input (multimodal). Minimum: -2147483648. Maximum: 2147483647. |
In webhook payloads
Webhook JSON uses protobuf field names (snake_case).
| Field | Type | Presence | Meaning |
|---|---|---|---|
cached_tokens | integer (int32) | Optional | Prompt tokens served from cache (cache READ). Minimum: -2147483648. Maximum: 2147483647. |
cache_write_tokens | integer (int32) | Optional | Prompt tokens written to cache this call (cache WRITE). Minimum: -2147483648. Maximum: 2147483647. |
audio_tokens | integer (int32) | Optional | Prompt tokens from audio input (multimodal). Minimum: -2147483648. Maximum: 2147483647. |
video_tokens | integer (int32) | Optional | Prompt tokens from video input (multimodal). Minimum: -2147483648. Maximum: 2147483647. |
Where used
| Reference | Relationship |
|---|---|
| Append a message without generating | POST /api/v1/llm/append-message |
| Send a message to a conversation | POST /api/v1/llm/send-message |
| Send a message and wait for the result | POST /api/v1/llm/send-message-sync |
| 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 |
| Submit client-side tool results and wait for the next segment | POST /api/v1/llm/submit-client-tool-results-sync |
| llm.generation_completed | Webhook JSON uses protobuf field names (snake_case). |
| llm.message_published | Webhook JSON uses protobuf field names (snake_case). |
| Usage | Nested in model |
| Usage | Nested in model |
| Usage | Nested in model |
Download the public reference contract.
Document: DOC-API-MODEL-prompt-tokens-details.