DOC-API-MODEL-schema-1gstrgb39r#overview
StopOnFailureRule
Requested tool-selection rule for handling an execution failure. The current generation workflow stores these rules but does not evaluate them or stop a loop or run because of them.
The conditions in stopOnFailureRules, including priority, timeout inclusion and error matching, are not enforced. Do not rely on these fields as a stop control.
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-1gstrgb39r#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1gstrgb39r#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-1gstrgb39r#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1gstrgb39r#request-field-toolnamepatternstoolNamePatterns | Array of string | Optional | Requested tool-name selection; not evaluated by the current generation workflow. |
Section ID: DOC-API-MODEL-schema-1gstrgb39r#request-field-serveridsserverIds | Array of string | Optional | Requested MCP server selection; not evaluated by the current generation workflow. |
Section ID: DOC-API-MODEL-schema-1gstrgb39r#request-field-onfailureonFailure | string (FAILURE_MODE_CONTINUE, FAILURE_MODE_STOP_LOOP, FAILURE_MODE_STOP_RUN) or integer (int32) | Optional; explicit presence | See meaning below. |
Section ID: DOC-API-MODEL-schema-1gstrgb39r#request-field-includetimeoutsincludeTimeouts | boolean | Optional | See meaning below. |
Section ID: DOC-API-MODEL-schema-1gstrgb39r#request-field-errorsubstringserrorSubstrings | Array of string | Optional | See meaning below. |
Section ID: DOC-API-MODEL-schema-1gstrgb39r#request-field-prioritypriority | string (int64) | Optional | See meaning below. Pattern: ^-?\d+$. |
onFailure
Requested failure action; not evaluated by the current generation workflow.
STOP_LOOP or STOP_RUN
includeTimeouts
Requested inclusion of timeouts as failures; not evaluated by the current generation workflow.
treat timeouts as failure for this rule
errorSubstrings
Requested error-text selection; not evaluated by the current generation workflow.
only stop if error matches
priority
Requested rule priority; not evaluated by the current generation workflow.
lower evaluated first
Values of onFailure
Section ID: DOC-API-MODEL-schema-1gstrgb39r#request-values-onfailure
Requested scope of stopping after a tool execution failure.
| Value | No. | Form | Meaning |
|---|---|---|---|
FAILURE_MODE_CONTINUE | 0 | Canonical | Request continued processing after the failed tool call. |
FAILURE_MODE_STOP_LOOP | 1 | Canonical | Request stopping the current tool-execution loop after the failure. |
FAILURE_MODE_STOP_RUN | 2 | Canonical | Request stopping the generation run after the failure. |
In responses
Section ID: DOC-API-MODEL-schema-1gstrgb39r#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1gstrgb39r#field-toolnamepatternsSection ID: DOC-API-MODEL-schema-1gstrgb39r#response-field-toolnamepatternstoolNamePatterns | Array of string | Optional | Requested tool-name selection; not evaluated by the current generation workflow. |
Section ID: DOC-API-MODEL-schema-1gstrgb39r#field-serveridsSection ID: DOC-API-MODEL-schema-1gstrgb39r#response-field-serveridsserverIds | Array of string | Optional | Requested MCP server selection; not evaluated by the current generation workflow. |
Section ID: DOC-API-MODEL-schema-1gstrgb39r#field-onfailureSection ID: DOC-API-MODEL-schema-1gstrgb39r#response-field-onfailureonFailure | string (FAILURE_MODE_CONTINUE, FAILURE_MODE_STOP_LOOP, FAILURE_MODE_STOP_RUN) or integer (int32) | Optional; explicit presence | See meaning below. |
Section ID: DOC-API-MODEL-schema-1gstrgb39r#field-includetimeoutsSection ID: DOC-API-MODEL-schema-1gstrgb39r#response-field-includetimeoutsincludeTimeouts | boolean | Optional | See meaning below. |
Section ID: DOC-API-MODEL-schema-1gstrgb39r#field-errorsubstringsSection ID: DOC-API-MODEL-schema-1gstrgb39r#response-field-errorsubstringserrorSubstrings | Array of string | Optional | See meaning below. |
Section ID: DOC-API-MODEL-schema-1gstrgb39r#field-prioritySection ID: DOC-API-MODEL-schema-1gstrgb39r#response-field-prioritypriority | string (int64) | Optional | See meaning below. Pattern: ^-?\d+$. |
onFailure
Requested failure action; not evaluated by the current generation workflow.
STOP_LOOP or STOP_RUN
includeTimeouts
Requested inclusion of timeouts as failures; not evaluated by the current generation workflow.
treat timeouts as failure for this rule
errorSubstrings
Requested error-text selection; not evaluated by the current generation workflow.
only stop if error matches
priority
Requested rule priority; not evaluated by the current generation workflow.
lower evaluated first
Values of onFailure
Section ID: DOC-API-MODEL-schema-1gstrgb39r#response-values-onfailure
Requested scope of stopping after a tool execution failure.
| Value | No. | Form | Meaning |
|---|---|---|---|
FAILURE_MODE_CONTINUE | 0 | Canonical | Request continued processing after the failed tool call. |
FAILURE_MODE_STOP_LOOP | 1 | Canonical | Request stopping the current tool-execution loop after the failure. |
FAILURE_MODE_STOP_RUN | 2 | Canonical | Request stopping the generation run after the failure. |
Where used
Section ID: DOC-API-MODEL-schema-1gstrgb39r#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-1gstrgb39r