xbxbapi

Error codes

Diagnose authentication, billing, validation, and server errors.

Errors use the same { code, msg, data } envelope as successful responses. The msg field contains the actionable reason.

CodeMeaningWhat to do
401Missing or invalid API keyCheck the Authorization header
402Insufficient creditsTop up and retry; the message states required and available credits
403Account suspendedContact support
404Task not foundCheck taskId; customers can read only their own tasks
422Invalid parameterCorrect the request according to msg
429Rate limit exceededWait for the number of seconds in the Retry-After header, then retry
500Server or upstream errorRetry later; submitted tasks that fail are refunded

Rate limit

Each account can create at most 20 tasks per 10 seconds through createTask. The limit is shared by all API keys under the account. Requests over the limit return 429 with a Retry-After header. They are not queued and not charged. Querying tasks with recordInfo is not rate limited.

If you hit 429 regularly, contact us to request a higher limit.

Retry guidance

Retry transient 500 responses with exponential backoff. Retry 429 after the Retry-After delay. Do not retry 401, 402, 403, or 422 until the underlying request or account issue is fixed.

On this page