ModelError
Model-specific error context.
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 |
|---|---|---|---|
modelId | string | Optional | The model ID that caused the error. |
reason | string | Optional | Why the model failed (e.g., "invalid", "unavailable", "moderation_flagged"). |
alternativesTried | Array of string | Optional | Alternative models that were tried or could be tried. |
In responses
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
modelId | string | Optional | The model ID that caused the error. |
reason | string | Optional | Why the model failed (e.g., "invalid", "unavailable", "moderation_flagged"). |
alternativesTried | Array of string | Optional | Alternative models that were tried or could be tried. |
In webhook payloads
Webhook JSON uses protobuf field names (snake_case).
| Field | Type | Presence | Meaning |
|---|---|---|---|
model_id | string | Optional | The model ID that caused the error. |
reason | string | Optional | Why the model failed (e.g., "invalid", "unavailable", "moderation_flagged"). |
alternatives_tried | Array of string | Optional | Alternative models that were tried or could be tried. |
Where used
| Reference | Relationship |
|---|---|
| Submit client-side tool execution results | POST /api/v1/llm/submit-client-tool-results |
| Submit client-side tool results and wait for the next segment | POST /api/v1/llm/submit-client-tool-results-sync |
| Send a message and wait for the result | POST /api/v1/llm/send-message-sync |
| llm.generation_completed | Webhook JSON uses protobuf field names (snake_case). |
| ErrorDetails | Nested in model |
| ErrorDetails | Nested in model |
| ErrorDetails | Nested in model |
Download the public reference contract.
Document: DOC-API-MODEL-model-error.