Skip to main content
The REST API uses standard HTTP status codes and returns JSON error objects with detail about what went wrong.

Error Response Format

Error responses from the API have the same shape (the one exception is a 403 from an internal-only route, which returns the plain-text body internal only):
The status field is one of:

Examples

Bad request (400):
Not found (404):
Timeout (504):
Internal error (500):

HTTP Status Codes

Best Practices

  1. Implement exponential backoff for 500/504 errors
  2. Cache responses where appropriate
  3. Batch requests when possible
  4. Use WebSocket for real-time data instead of polling

SDK Error Handling

See TypeScript SDK Error Responses for SDK-specific error handling.

Authentication

How to get and use bearer tokens

REST Overview

API basics and available endpoints