DOC-API-MODEL-schema-1gu5od417l#overview
TimeoutPolicy
Bounds the run as a whole. This message has no per-tool or per-loop execution timeout. Approval and client-result answer windows are configured separately on ToolExecutionPolicy; those waits do not cancel an already dispatched remote action.
Set a finite timeouts.overallMs when the task needs a duration limit. It is measured from run start; zero or omission leaves the run-level duration unbounded.
When Travila observes that the budget has elapsed, the run can end TIMED_OUT and pending calls can be closed with endReason: "run_timed_out". A call still awaiting approval has not been dispatched. The timeout does not guarantee a remote action stops at that instant, establish whether it took effect, or roll it back.
Use endReason to distinguish a run deadline from a call's own answer window: an unanswered approval reads approval_timeout, and an unanswered client tool reads client_timeout. Read the actual tool status too; approval and client-tool expiry can produce FAILED or TIMED_OUT. Run and individual tool outcomes are different fields.
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-1gu5od417l#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1gu5od417l#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-1gu5od417l#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1gu5od417l#request-field-overallmsoverallMs | string (int64) | Optional | Overall run budget in milliseconds, measured from run start. Zero or omission leaves this run-level bound unset. The workflow checks the deadline and can end with AGENT_STATUS_TIMED_OUT; it cannot cancel or undo a remote action already dispatched. Approval and client-result waits retain their separate finite limits. Pattern: ^-?\d+$. |
In responses
Section ID: DOC-API-MODEL-schema-1gu5od417l#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1gu5od417l#field-overallmsSection ID: DOC-API-MODEL-schema-1gu5od417l#response-field-overallmsoverallMs | string (int64) | Optional | Overall run budget in milliseconds, measured from run start. Zero or omission leaves this run-level bound unset. The workflow checks the deadline and can end with AGENT_STATUS_TIMED_OUT; it cannot cancel or undo a remote action already dispatched. Approval and client-result waits retain their separate finite limits. Pattern: ^-?\d+$. |
Where used
Section ID: DOC-API-MODEL-schema-1gu5od417l#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 |
| Update prompt variables | POST /api/v1/llm/update-prompt-variables |
| Update conversation settings | POST /api/v1/llm/update-settings |
| 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 |
|---|---|
| ToolExecutionPolicy | Nested in model |
| ToolExecutionPolicy | Nested in model |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1gu5od417l