Skip to main content

API concepts

Error handling​

The API returns standard error objects:

{
  "status_code": "number",
  "message": "string",
  "error_detail": "string | null",
  "failedReason": "string | null"
}

See the reference for particular endpoints to see exactly what errors are possible.

Status codes​

The API uses normal HTTP status codes to describe the response.

For example, a good response will come back with a 2xx code, and bad requests will get 4xx.

This means that generally speaking, code like if (res.ok) ... is enough to understand if a request has succeeded.

Data format​

The API supports JSON.

Some endpoints accept image data or other files. When calling them, add a Content-Type: multipart/form-data header.

Check the reference for the particular endpoint if unsure.

Rate limits​

Authenticated requests do not usually have rate limits, but very high volume requests may be rejected with a 429 status code.

Speak to us if you think this might affect you.