DOC-API-MODEL-schema-1gi26i7r89#overview
ReasoningOptions
Reasoning options
Supported effort settings depend on the selected model; a setting can be rejected or ignored when unsupported. To ask for the answer without returned reasoning text, set exclude to true. That controls the output you receive, not whether the model uses or bills reasoning tokens.
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-1gi26i7r89#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1gi26i7r89#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-1gi26i7r89#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1gi26i7r89#request-field-efforteffort | string (EFFORT_HIGH, EFFORT_MEDIUM, EFFORT_LOW, EFFORT_XHIGH, EFFORT_MINIMAL, EFFORT_NONE) or integer (int32) | Optional; explicit presence | Requested model reasoning effort. |
Section ID: DOC-API-MODEL-schema-1gi26i7r89#request-field-maxtokensmaxTokens | string (int64) | Optional | Maximum reasoning-token count requested from the model provider. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1gi26i7r89#request-field-excludeexclude | boolean | Optional | Whether the provider should omit reasoning content from its response. |
Section ID: DOC-API-MODEL-schema-1gi26i7r89#request-field-includereasoninghistoryincludeReasoningHistory | boolean | Optional | When true (default), reasoning content from previous turns is included in multi-turn requests to enable provider continuity. |
Values of effort
Section ID: DOC-API-MODEL-schema-1gi26i7r89#request-values-effort
Requested reasoning effort sent to the model provider; supported levels and their effect depend on the chosen model.
| Value | No. | Form | Meaning |
|---|---|---|---|
EFFORT_HIGH | 0 | Canonical | Request the provider's high reasoning-effort level. |
EFFORT_MEDIUM | 1 | Canonical | Request the provider's medium reasoning-effort level. |
EFFORT_LOW | 2 | Canonical | Request the provider's low reasoning-effort level. |
EFFORT_XHIGH | 3 | Canonical | Request the provider's extra-high reasoning-effort level where supported. |
EFFORT_MINIMAL | 4 | Canonical | Request the provider's minimal reasoning-effort level where supported. |
EFFORT_NONE | 5 | Canonical | Request no reasoning effort where the provider supports disabling it. |
In responses
Section ID: DOC-API-MODEL-schema-1gi26i7r89#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1gi26i7r89#field-effortSection ID: DOC-API-MODEL-schema-1gi26i7r89#response-field-efforteffort | string (EFFORT_HIGH, EFFORT_MEDIUM, EFFORT_LOW, EFFORT_XHIGH, EFFORT_MINIMAL, EFFORT_NONE) or integer (int32) | Optional; explicit presence | Requested model reasoning effort. |
Section ID: DOC-API-MODEL-schema-1gi26i7r89#field-maxtokensSection ID: DOC-API-MODEL-schema-1gi26i7r89#response-field-maxtokensmaxTokens | string (int64) | Optional | Maximum reasoning-token count requested from the model provider. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1gi26i7r89#field-excludeSection ID: DOC-API-MODEL-schema-1gi26i7r89#response-field-excludeexclude | boolean | Optional | Whether the provider should omit reasoning content from its response. |
Section ID: DOC-API-MODEL-schema-1gi26i7r89#field-includereasoninghistorySection ID: DOC-API-MODEL-schema-1gi26i7r89#response-field-includereasoninghistoryincludeReasoningHistory | boolean | Optional | When true (default), reasoning content from previous turns is included in multi-turn requests to enable provider continuity. |
Values of effort
Section ID: DOC-API-MODEL-schema-1gi26i7r89#response-values-effort
Requested reasoning effort sent to the model provider; supported levels and their effect depend on the chosen model.
| Value | No. | Form | Meaning |
|---|---|---|---|
EFFORT_HIGH | 0 | Canonical | Request the provider's high reasoning-effort level. |
EFFORT_MEDIUM | 1 | Canonical | Request the provider's medium reasoning-effort level. |
EFFORT_LOW | 2 | Canonical | Request the provider's low reasoning-effort level. |
EFFORT_XHIGH | 3 | Canonical | Request the provider's extra-high reasoning-effort level where supported. |
EFFORT_MINIMAL | 4 | Canonical | Request the provider's minimal reasoning-effort level where supported. |
EFFORT_NONE | 5 | Canonical | Request no reasoning effort where the provider supports disabling it. |
Where used
Section ID: DOC-API-MODEL-schema-1gi26i7r89#where-used
| Reference | Relationship |
|---|---|
| Create an agent profile | POST /api/v1/agent-profiles/create |
| Get an agent profile | POST /api/v1/agent-profiles/get |
| Import a prompt library | POST /api/v1/agent-profiles/import |
| List agent profiles | POST /api/v1/agent-profiles/list |
| Update an agent profile | POST /api/v1/agent-profiles/update |
| 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 |
| Update context management settings | POST /api/v1/llm/update-context-management-settings |
| Update default generation config | POST /api/v1/llm/update-default-generation-config |
| Get the caller's end-user profile | POST /api/v1/enduser/get |
| Append a message without generating | POST /api/v1/llm/append-message |
| Create a new conversation thread | POST /api/v1/llm/create-thread |
| Send a message to a conversation | POST /api/v1/llm/send-message |
| Update the caller's default generation config | POST /api/v1/enduser/update-generation-config |
| ReceiveMessageRequest | API JSON uses JSON field names (camelCase). |
| ClientToolDispatch | API JSON uses JSON field names (camelCase). |
Models containing this value
| Model | Relationship |
|---|---|
| GenerationConfig | Nested in model |
| GenerationConfig | Nested in model |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1gi26i7r89