Section ID:
DOC-API-MODEL-schema-1f66rlcp5a#overview
UpstreamError
Context from an upstream provider error, including the provider name when reported.
Meaning and usage
Section ID: DOC-API-MODEL-schema-1f66rlcp5a#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1f66rlcp5a#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-1f66rlcp5a#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1f66rlcp5a#request-field-providerprovider | string | Optional | Name of the upstream provider that reported the error. |
Section ID: DOC-API-MODEL-schema-1f66rlcp5a#request-field-statuscodestatusCode | string (int64) | Optional | HTTP status code returned by the provider. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1f66rlcp5a#request-field-rawbodyrawBody | string | Optional | Raw error body from the provider, truncated to 512 bytes. |
In responses
Section ID: DOC-API-MODEL-schema-1f66rlcp5a#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1f66rlcp5a#field-providerSection ID: DOC-API-MODEL-schema-1f66rlcp5a#response-field-providerprovider | string | Optional | Name of the upstream provider that reported the error. |
Section ID: DOC-API-MODEL-schema-1f66rlcp5a#field-statuscodeSection ID: DOC-API-MODEL-schema-1f66rlcp5a#response-field-statuscodestatusCode | string (int64) | Optional | HTTP status code returned by the provider. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1f66rlcp5a#field-rawbodySection ID: DOC-API-MODEL-schema-1f66rlcp5a#response-field-rawbodyrawBody | string | Optional | Raw error body from the provider, truncated to 512 bytes. |
Where used
Section ID: DOC-API-MODEL-schema-1f66rlcp5a#where-used
| Reference | Relationship |
|---|---|
| Send a message and wait for the result | POST /api/v1/llm/send-message-sync |
| Submit client-side tool results and wait for the next segment | POST /api/v1/llm/submit-client-tool-results-sync |
| Submit client-side tool execution results | POST /api/v1/llm/submit-client-tool-results |
Models containing this value
| Model | Relationship |
|---|---|
| ErrorDetails | Nested in model |
| ErrorDetails | Nested in model |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1f66rlcp5a