Errors

Error envelope

Every failing response returns the same JSON body:

{
  "error": "Human-readable message",
  "code": "machine_readable_code"
}

error is for humans and may change; code is the stable, machine-readable value your integration should branch on.

`code`	HTTP status	Meaning
`unauthenticated`	401	No API key was sent
`invalid_key`	401	The key is not recognised
`key_revoked`	401	The key has been revoked
`insufficient_scope`	403	The API key lacks the scope the endpoint requires
`client_suspended`	403	The API client is suspended
`not_found`	404	The requested resource does not exist
`invalid_parameter`	400	A request parameter was invalid
`rate_limited`	429	You exceeded your tier’s burst limit or daily quota
`service_unavailable`	503	The whole API is temporarily switched off
`internal_error`	500	An unexpected server error occurred

See Authentication for the 401/403 codes in context, and Rate limits for rate_limited and service_unavailable.