Skip to main content

UpstreamError

Context from an upstream provider error.

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
providerstringOptionalName of the upstream provider that reported the error.
statusCodeinteger (int32)OptionalHTTP status code returned by the provider. Minimum: -2147483648. Maximum: 2147483647.
rawBodystringOptionalRaw error body from the provider. Truncated to 512 bytes (enforced at Go level).

In responses​

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
providerstringOptionalName of the upstream provider that reported the error.
statusCodeinteger (int32)OptionalHTTP status code returned by the provider. Minimum: -2147483648. Maximum: 2147483647.
rawBodystringOptionalRaw error body from the provider. Truncated to 512 bytes (enforced at Go level).

In webhook payloads​

Webhook JSON uses protobuf field names (snake_case).

FieldTypePresenceMeaning
providerstringOptionalName of the upstream provider that reported the error.
status_codeinteger (int32)OptionalHTTP status code returned by the provider. Minimum: -2147483648. Maximum: 2147483647.
raw_bodystringOptionalRaw error body from the provider. Truncated to 512 bytes (enforced at Go level).

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).
ErrorDetailsNested in model
ErrorDetailsNested in model
ErrorDetailsNested in model

Download the public reference contract.

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