Skip to main content

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.

Usage profiles​

UsageFields and validation
In requestsView fields
In responsesView fields
In webhook payloadsView fields

In requests​

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
overallMsinteger (int32)OptionalOverall 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. Minimum: -2147483648. Maximum: 2147483647.

In responses​

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
overallMsinteger (int32)OptionalOverall 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. Minimum: -2147483648. Maximum: 2147483647.

In webhook payloads​

Webhook JSON uses protobuf field names (snake_case).

FieldTypePresenceMeaning
overall_msinteger (int32)OptionalOverall 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. Minimum: -2147483648. Maximum: 2147483647.

Where used​

ReferenceRelationship
Create an agent profilePOST /api/v1/agent-profiles/create
Import a prompt libraryPOST /api/v1/agent-profiles/import
Update an agent profilePOST /api/v1/agent-profiles/update
Append a message without generatingPOST /api/v1/llm/append-message
Create a new conversation threadPOST /api/v1/llm/create-thread
Send a message to a conversationPOST /api/v1/llm/send-message
Send a message and wait for the resultPOST /api/v1/llm/send-message-sync
Update context management settingsPOST /api/v1/llm/update-context-management-settings
Update default generation configPOST /api/v1/llm/update-default-generation-config
Update conversation settingsPOST /api/v1/llm/update-settings
Update the caller's default generation configPOST /api/v1/enduser/update-generation-config
Get an agent profilePOST /api/v1/agent-profiles/get
List agent profilesPOST /api/v1/agent-profiles/list
Withdraw your rating on a messagePOST /api/v1/llm/delete-message-rating
Get full conversation statePOST /api/v1/llm/conversation-state
Rate an assistant messagePOST /api/v1/llm/rate-message
Submit client-side tool results and wait for the next segmentPOST /api/v1/llm/submit-client-tool-results-sync
Update prompt variablesPOST /api/v1/llm/update-prompt-variables
Get the caller's end-user profilePOST /api/v1/enduser/get
Generation configurationAPI JSON uses JSON field names (camelCase).
llm.generation_startedWebhook JSON uses protobuf field names (snake_case).
llm.message_publishedWebhook JSON uses protobuf field names (snake_case).
ToolExecutionPolicyNested in model
ToolExecutionPolicyNested in model
ToolExecutionPolicyNested in model

Download the public reference contract.

Document: DOC-API-MODEL-timeout-policy.