ErrorInfo
Machine-readable error identification (per AIP-193, every error must include this).
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 |
|---|---|---|---|
reason | string | Optional | Stable machine-readable reason string (e.g., "MODEL_NOT_FOUND", "RATE_LIMITED", "MODERATION_FLAGGED"). Unique within the domain. Clients may switch on this field. |
domain | string | Optional | Machine-readable namespace identifying the origin of the error. |
metadata | Map from string to string | Optional | Arbitrary key-value metadata. If the message field mentions a specific value (model name, field path, etc.), it MUST also appear here. |
In responses
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
reason | string | Optional | Stable machine-readable reason string (e.g., "MODEL_NOT_FOUND", "RATE_LIMITED", "MODERATION_FLAGGED"). Unique within the domain. Clients may switch on this field. |
domain | string | Optional | Machine-readable namespace identifying the origin of the error. |
metadata | Map from string to string | Optional | Arbitrary key-value metadata. If the message field mentions a specific value (model name, field path, etc.), it MUST also appear here. |
In webhook payloads
Webhook JSON uses protobuf field names (snake_case).
| Field | Type | Presence | Meaning |
|---|---|---|---|
reason | string | Optional | Stable machine-readable reason string (e.g., "MODEL_NOT_FOUND", "RATE_LIMITED", "MODERATION_FLAGGED"). Unique within the domain. Clients may switch on this field. |
domain | string | Optional | Machine-readable namespace identifying the origin of the error. |
metadata | Map from string to string | Optional | Arbitrary key-value metadata. If the message field mentions a specific value (model name, field path, etc.), it MUST also appear here. |
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-error-info.