DOC-API-MODEL-schema-1i6q4qpg72#overview
CompletionTokensDetails
Breakdown of completion-token usage. Categories are measured by different upstream tokenizers and need not sum to completion_tokens; reasoning_tokens can exceed completion_tokens. One category must not be derived by subtracting the others.
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-1i6q4qpg72#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1i6q4qpg72#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-1i6q4qpg72#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1i6q4qpg72#request-field-reasoningtokensreasoningTokens | string (int64) | Optional | Tokens used for reasoning/thinking. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1i6q4qpg72#request-field-imagetokensimageTokens | string (int64) | Optional | Completion tokens emitted as image output. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1i6q4qpg72#request-field-audiotokensaudioTokens | string (int64) | Optional | Completion tokens emitted as audio output. Pattern: ^-?\d+$. |
In responses
Section ID: DOC-API-MODEL-schema-1i6q4qpg72#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1i6q4qpg72#field-reasoningtokensSection ID: DOC-API-MODEL-schema-1i6q4qpg72#response-field-reasoningtokensreasoningTokens | string (int64) | Optional | Tokens used for reasoning/thinking. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1i6q4qpg72#field-imagetokensSection ID: DOC-API-MODEL-schema-1i6q4qpg72#response-field-imagetokensimageTokens | string (int64) | Optional | Completion tokens emitted as image output. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1i6q4qpg72#field-audiotokensSection ID: DOC-API-MODEL-schema-1i6q4qpg72#response-field-audiotokensaudioTokens | string (int64) | Optional | Completion tokens emitted as audio output. Pattern: ^-?\d+$. |
Where used
Section ID: DOC-API-MODEL-schema-1i6q4qpg72#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-1i6q4qpg72