DOC-API-MODEL-schema-1h5dj58uph#overview
TurnContextConfig
Configuration for turn-aware LLM generation
Turn context tells the model the current generation number and remaining allowance, with tool guidance based on that allowance. This annotation is enabled by default and is not persisted in message history. Its presentation options belong in the generation configuration reference; the annotation itself does not change the run limit.
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-1h5dj58uph#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1h5dj58uph#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-1h5dj58uph#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1h5dj58uph#request-field-enabledenabled | boolean | Optional | Enable turn context injection into system prompt Default: true |
Section ID: DOC-API-MODEL-schema-1h5dj58uph#request-field-includetoolguidanceincludeToolGuidance | boolean | Optional | Include tool usage guidance based on remaining turns Default: false (can enable for agentic workflows) |
Section ID: DOC-API-MODEL-schema-1h5dj58uph#request-field-formatformat | string (minimal, standard, verbose) | Required in requests | Format for turn context "minimal": "[Turn 2/5]" "standard": "[Turn 2 of 5 - 3 turns remaining. Plan your response accordingly.]" "verbose": Includes detailed behavioral guidance Default: "standard" |
Request validation
Section ID: DOC-API-MODEL-schema-1h5dj58uph#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 |
|---|---|---|
format | Allowed values | minimal, standard, verbose |
In responses
Section ID: DOC-API-MODEL-schema-1h5dj58uph#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1h5dj58uph#field-enabledSection ID: DOC-API-MODEL-schema-1h5dj58uph#response-field-enabledenabled | boolean | Optional | Enable turn context injection into system prompt Default: true |
Section ID: DOC-API-MODEL-schema-1h5dj58uph#field-includetoolguidanceSection ID: DOC-API-MODEL-schema-1h5dj58uph#response-field-includetoolguidanceincludeToolGuidance | boolean | Optional | Include tool usage guidance based on remaining turns Default: false (can enable for agentic workflows) |
Section ID: DOC-API-MODEL-schema-1h5dj58uph#field-formatSection ID: DOC-API-MODEL-schema-1h5dj58uph#response-field-formatformat | string | Required in requests | Format for turn context "minimal": "[Turn 2/5]" "standard": "[Turn 2 of 5 - 3 turns remaining. Plan your response accordingly.]" "verbose": Includes detailed behavioral guidance Default: "standard" |
DOC-API-MODEL-schema-1h5dj58uph#validation
Request validation
Section ID: DOC-API-MODEL-schema-1h5dj58uph#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 |
|---|---|---|
format | Allowed values | minimal, standard, verbose |
Where used
Section ID: DOC-API-MODEL-schema-1h5dj58uph#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-1h5dj58uph