Skip to main content
Section ID: DOC-API-MODEL-schema-1es9uii84j#overview

ErrorInfo

Machine-readable error identification (per AIP-193, every error must include this).

Meaning and usage​

Section ID: DOC-API-MODEL-schema-1es9uii84j#meaning

See the definition above.

Usage profiles​

Section ID: DOC-API-MODEL-schema-1es9uii84j#fields

UsageFields and validation
In requestsView fields
In responsesView fields

In requests​

Section ID: DOC-API-MODEL-schema-1es9uii84j#request

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
Section ID: DOC-API-MODEL-schema-1es9uii84j#request-field-reasonreasonstringOptionalStable machine-readable reason string (e.g., "MODEL_NOT_FOUND", "RATE_LIMITED", "MODERATION_FLAGGED"). Unique within the domain. Clients may switch on this field.
Section ID: DOC-API-MODEL-schema-1es9uii84j#request-field-domaindomainstringOptionalMachine-readable namespace identifying the origin of the error.
Section ID: DOC-API-MODEL-schema-1es9uii84j#request-field-metadatametadataMap from string to stringOptionalArbitrary key-value metadata. If the message field mentions a specific value (model name, field path, etc.), it MUST also appear here.

In responses​

Section ID: DOC-API-MODEL-schema-1es9uii84j#response

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
Section ID: DOC-API-MODEL-schema-1es9uii84j#field-reasonSection ID: DOC-API-MODEL-schema-1es9uii84j#response-field-reasonreasonstringOptionalStable machine-readable reason string (e.g., "MODEL_NOT_FOUND", "RATE_LIMITED", "MODERATION_FLAGGED"). Unique within the domain. Clients may switch on this field.
Section ID: DOC-API-MODEL-schema-1es9uii84j#field-domainSection ID: DOC-API-MODEL-schema-1es9uii84j#response-field-domaindomainstringOptionalMachine-readable namespace identifying the origin of the error.
Section ID: DOC-API-MODEL-schema-1es9uii84j#field-metadataSection ID: DOC-API-MODEL-schema-1es9uii84j#response-field-metadatametadataMap from string to stringOptionalArbitrary key-value metadata. If the message field mentions a specific value (model name, field path, etc.), it MUST also appear here.

Where used​

Section ID: DOC-API-MODEL-schema-1es9uii84j#where-used

ReferenceRelationship
Send a message and wait for the resultPOST /api/v1/llm/send-message-sync
Submit client-side tool results and wait for the next segmentPOST /api/v1/llm/submit-client-tool-results-sync
Submit client-side tool execution resultsPOST /api/v1/llm/submit-client-tool-results
Models containing this value
ModelRelationship
ErrorDetailsNested in model
ErrorDetailsNested in model

Download the public reference contract.

Document ID: DOC-API-MODEL-schema-1es9uii84j