error

⚠️
Preview — this feature is being built; the design below is the spec.

Received on the stream and in the event list. Something failed inside the turn.

Example

id: evt_01JC7M3B
data: {"type": "error", "error": {"type": "invalid_request_error", "code": "session_budget_exhausted", "message": "The session cost budget of $2.00 is used up.", "request_id": "req_01JC7M3F"}}

Fields

FieldMeaning
errorSame envelope as HTTP errors.

Handling

Always followed by status.changed. Show a friendly message; check the code to decide whether to start a new session.

Was this page helpful?