Section ID:
DOC-API-MODEL-schema-1f2939tg20#overview
ModelError
Model-specific error context.
Meaning and usage
Section ID: DOC-API-MODEL-schema-1f2939tg20#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1f2939tg20#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-1f2939tg20#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1f2939tg20#request-field-modelidmodelId | string | Optional | The model ID that caused the error. |
Section ID: DOC-API-MODEL-schema-1f2939tg20#request-field-reasonreason | string | Optional | Why the model failed (e.g., "invalid", "unavailable", "moderation_flagged"). |
Section ID: DOC-API-MODEL-schema-1f2939tg20#request-field-alternativestriedalternativesTried | Array of string | Optional | Alternative models that were tried or could be tried. |
In responses
Section ID: DOC-API-MODEL-schema-1f2939tg20#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1f2939tg20#field-modelidSection ID: DOC-API-MODEL-schema-1f2939tg20#response-field-modelidmodelId | string | Optional | The model ID that caused the error. |
Section ID: DOC-API-MODEL-schema-1f2939tg20#field-reasonSection ID: DOC-API-MODEL-schema-1f2939tg20#response-field-reasonreason | string | Optional | Why the model failed (e.g., "invalid", "unavailable", "moderation_flagged"). |
Section ID: DOC-API-MODEL-schema-1f2939tg20#field-alternativestriedSection ID: DOC-API-MODEL-schema-1f2939tg20#response-field-alternativestriedalternativesTried | Array of string | Optional | Alternative models that were tried or could be tried. |
Where used
Section ID: DOC-API-MODEL-schema-1f2939tg20#where-used
| Reference | Relationship |
|---|---|
| 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 |
| Submit client-side tool execution results | POST /api/v1/llm/submit-client-tool-results |
Models containing this value
| Model | Relationship |
|---|---|
| ErrorDetails | Nested in model |
| ErrorDetails | Nested in model |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1f2939tg20