ErrorDetails
Typed error details container. Concrete fields instead of Any for type safety across languages. At most one of each detail type.
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 |
|---|---|---|---|
errorInfo | ErrorInfo | Optional | Identifies the error for machine consumption. REQUIRED on all errors per AIP-193 (enforced at Go helper level). |
retryInfo | RetryInfo | Optional | Retry guidance for transient errors. |
fieldViolations | Array of FieldViolation | Optional | Field-level validation failures. |
upstreamError | UpstreamError | Optional | Upstream provider error context. |
modelError | ModelError | Optional | Model-specific error context. |
helpLinks | Array of HelpLink | Optional | Help links for error resolution. |
In responses
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
errorInfo | ErrorInfo | Optional | Identifies the error for machine consumption. REQUIRED on all errors per AIP-193 (enforced at Go helper level). |
retryInfo | RetryInfo | Optional | Retry guidance for transient errors. |
fieldViolations | Array of FieldViolation | Optional | Field-level validation failures. |
upstreamError | UpstreamError | Optional | Upstream provider error context. |
modelError | ModelError | Optional | Model-specific error context. |
helpLinks | Array of HelpLink | Optional | Help links for error resolution. |
In webhook payloads
Webhook JSON uses protobuf field names (snake_case).
| Field | Type | Presence | Meaning |
|---|---|---|---|
error_info | ErrorInfo | Optional | Identifies the error for machine consumption. REQUIRED on all errors per AIP-193 (enforced at Go helper level). |
retry_info | RetryInfo | Optional | Retry guidance for transient errors. |
field_violations | Array of FieldViolation | Optional | Field-level validation failures. |
upstream_error | UpstreamError | Optional | Upstream provider error context. |
model_error | ModelError | Optional | Model-specific error context. |
help_links | Array of HelpLink | Optional | Help links for error resolution. |
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). |
| RpcError | Nested in model |
| RpcError | Nested in model |
| RpcError | Nested in model |
Download the public reference contract.
Document: DOC-API-MODEL-error-details.