Error handling

Our API uses a consistent error response format to help clients reliably detect and handle errors.

When a request fails, the API returns a JSON object with the following structure:

{
  "status": "error",
  "message": "Something went wrong",
  "errorId": "123467890"
}

Field	Type	Required	Description
`status`	string	Yes	Always set to `"error"` for failed requests.
`message`	string	Yes	A human-readable description of what went wrong. This message is intended for developers and may change over time.
`errorId`	string	No	A unique identifier for this specific error occurrence. Used for troubleshooting and support.

The errorId field may or may not be present in the response.

If errorId is provided, it uniquely identifies the error on our side.
If you experience issues or need support, please include the errorId when contacting us - this allows us to locate the problem much faster.
If errorId is not present, the error can usually be understood and resolved based on the message alone.

Clients should not rely on errorId always being present and should treat it as optional.