Error Codes

Error Handling Overview

The API uses standardized error responses to help developers quickly identify and resolve issues. Each error response includes:

A relevant HTTP status code (e.g. 401, 403, 422)

A unique, machine-readable error code (e.g. API_KEY_INVALID)

A short, human-readable message describing the error

An optional errors array for field-specific issues (typically with 422 responses)

Use these codes to programmatically handle errors in your client logic or display clear messages to users.

Status	Code	Description
401	API_KEY_REQUIRED	No API key was provided
401	API_KEY_INVALID	API key is invalid or unauthorized

Status	Code	Description
403	ACCESS_DENIED_IP	Access denied due to IP restrictions
403	ACCESS_DENIED_PERMISSIONS	API key lacks required permissions
403	API_KEY_DISABLED	The API key has been disabled

Status	Code	Description
400	BAD_REQUEST	Malformed request or missing fields
404	RESOURCE_NOT_FOUND	Requested resource does not exist
409	CONFLICT	Request conflicts with existing data
422	VALIDATION_FAILED	Validation errors — see `errors` array for details

Status	Code	Description
500	INTERNAL_SERVER_ERROR	Unexpected server error
502	BAD_GATEWAY	Invalid response from an upstream service
503	SERVICE_UNAVAILABLE	Service is temporarily down (e.g., maintenance)
504	GATEWAY_TIMEOUT	No response from an upstream service in time

Property	Type	Description
success	boolean	Whether the request was successful (`true/false`)
code	string	Error code identifier (e.g., `API_KEY_INVALID`)
message	string	Human-readable error message
errors	array	Optional array of field-specific or validation errors