Skip to main content

ErrorDetails

Typed error details container. Concrete fields instead of Any for type safety across languages. At most one of each detail type.

Usage profiles​

UsageFields and validation
In requestsView fields
In responsesView fields
In webhook payloadsView fields

In requests​

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
errorInfoErrorInfoOptionalIdentifies the error for machine consumption. REQUIRED on all errors per AIP-193 (enforced at Go helper level).
retryInfoRetryInfoOptionalRetry guidance for transient errors.
fieldViolationsArray of FieldViolationOptionalField-level validation failures.
upstreamErrorUpstreamErrorOptionalUpstream provider error context.
modelErrorModelErrorOptionalModel-specific error context.
helpLinksArray of HelpLinkOptionalHelp links for error resolution.

In responses​

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
errorInfoErrorInfoOptionalIdentifies the error for machine consumption. REQUIRED on all errors per AIP-193 (enforced at Go helper level).
retryInfoRetryInfoOptionalRetry guidance for transient errors.
fieldViolationsArray of FieldViolationOptionalField-level validation failures.
upstreamErrorUpstreamErrorOptionalUpstream provider error context.
modelErrorModelErrorOptionalModel-specific error context.
helpLinksArray of HelpLinkOptionalHelp links for error resolution.

In webhook payloads​

Webhook JSON uses protobuf field names (snake_case).

FieldTypePresenceMeaning
error_infoErrorInfoOptionalIdentifies the error for machine consumption. REQUIRED on all errors per AIP-193 (enforced at Go helper level).
retry_infoRetryInfoOptionalRetry guidance for transient errors.
field_violationsArray of FieldViolationOptionalField-level validation failures.
upstream_errorUpstreamErrorOptionalUpstream provider error context.
model_errorModelErrorOptionalModel-specific error context.
help_linksArray of HelpLinkOptionalHelp links for error resolution.

Where used​

ReferenceRelationship
Submit client-side tool execution resultsPOST /api/v1/llm/submit-client-tool-results
Submit client-side tool results and wait for the next segmentPOST /api/v1/llm/submit-client-tool-results-sync
Send a message and wait for the resultPOST /api/v1/llm/send-message-sync
llm.generation_completedWebhook JSON uses protobuf field names (snake_case).
RpcErrorNested in model
RpcErrorNested in model
RpcErrorNested in model

Download the public reference contract.

Document: DOC-API-MODEL-error-details.