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.
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 |
|---|---|---|---|
enabled | boolean | Optional | Enable turn context injection into system prompt Default: true |
includeToolGuidance | boolean | Optional | Include tool usage guidance based on remaining turns Default: false (can enable for agentic workflows) |
format | 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
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
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
enabled | boolean | Optional | Enable turn context injection into system prompt Default: true |
includeToolGuidance | boolean | Optional | Include tool usage guidance based on remaining turns Default: false (can enable for agentic workflows) |
format | 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" |
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 webhook payloads
Webhook JSON uses protobuf field names (snake_case).
| Field | Type | Presence | Meaning |
|---|---|---|---|
enabled | boolean | Optional | Enable turn context injection into system prompt Default: true |
include_tool_guidance | boolean | Optional | Include tool usage guidance based on remaining turns Default: false (can enable for agentic workflows) |
format | 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" |
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 |
Where used
| Reference | Relationship |
|---|---|
| Create an agent profile | POST /api/v1/agent-profiles/create |
| Import a prompt library | POST /api/v1/agent-profiles/import |
| Update an agent profile | POST /api/v1/agent-profiles/update |
| 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 |
| Send a message and wait for the result | POST /api/v1/llm/send-message-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 |
| Update the caller's default generation config | POST /api/v1/enduser/update-generation-config |
| Get an agent profile | POST /api/v1/agent-profiles/get |
| List agent profiles | POST /api/v1/agent-profiles/list |
| 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 |
| Get the caller's end-user profile | POST /api/v1/enduser/get |
| Generation configuration | API JSON uses JSON field names (camelCase). |
| llm.generation_started | Webhook JSON uses protobuf field names (snake_case). |
| llm.message_published | Webhook JSON uses protobuf field names (snake_case). |
| GenerationConfig | Nested in model |
| GenerationConfig | Nested in model |
| GenerationConfig | Nested in model |
Download the public reference contract.
Document: DOC-API-MODEL-turn-context-config.