Skip to main content

​
REST (HTTP)

Unless an endpoint documents otherwise, expect JSON error bodies on failure. The precise schema is defined per response in openapi.json (4xx / 5xx entries and components.schemas).

​
Common status codes

​
Parsing errors in clients

  1. Read HTTP status first.
  2. Parse the response body if present (often an object with message, code, or nested error fields — confirm against OpenAPI).
  3. Log request id or trace headers if the API exposes them (names vary by deployment).

​
WebSocket application errors

The AsyncAPI contract includes a ServerMessage::Error variant: a JSON text frame shaped like an object with an Error string field carrying a human-readable message. Example shape (conceptual):
On Error, decide whether to fix the subscription payload, reconnect, or surface the message in your application logs. The connection may stay open or the server may close it depending on policy — treat disconnects as recoverable: reconnect and resubscribe as described in Public WebSocket streams and Private WebSocket streams.

​
Where to debug quickly