Documentation navigation

OpenAPI

Errors

Responses use a consistent error envelope so your application can handle failures safely.

  1. Read the error code

    Use the response error code and request ID to identify the cause.

  2. Correct and retry

    Correct invalid parameters or permissions before retrying; do not immediately retry rate-limit errors.

Response example
{
  "success": false,
  "data": null,
  "error": {
    "code": 42901,
    "message": "Rate limit exceeded. Please try again later."
  },
  "meta": {
    "request_id": "example_request"
  }
}