status field. Check both to confirm whether a request succeeded and to handle failures programmatically.
Response shape
Successful and failed requests share a consistent envelope, so you can branch onstatus before reading data.
1 when the request succeeds, -1 when it fails. Always check status in addition to the HTTP status code.Present only on errors. A human-readable explanation of what went wrong.
Quick reference
| Code | Name | Meaning |
|---|---|---|
200 | OK | The request succeeded and data was returned. |
400 | Bad Request | Not enough credits to complete the request. |
401 | Unauthorized | The API key is missing or invalid. |
422 | Unprocessable Entity | The request is malformed or a required field is missing. |
500 | Server Error | Something went wrong on our side. |
200 — OK
The request was processed successfully.
data object contains your result, and credit_count reports your remaining balance. A 200 is only returned when status is 1.
Response
400 — Not enough credits
Your account does not have enough credits to complete the request. How to resolve- Review your remaining balance from the dashboard.
- Top up credits or upgrade your plan, then retry the request.
Response
401 — Unauthorized
Thex-api-key header is missing, malformed, or invalid.
How to resolve
- Confirm you are sending the
x-api-keyheader on every request. - Copy your key exactly from Account » API key in the dashboard — keys are case-sensitive and contain no spaces.
- Make sure the key has not been rotated or revoked.
Response
422 — Unprocessable Entity
The request reached the API but could not be processed — usually a missing required field, a typo in a parameter name, or a value in the wrong format. How to resolve- Check the Attributes section of the endpoint for required parameters and accepted formats.
- Send the body as
application/x-www-form-urlencoded(or JSON) with the exact field names shown in the request sample.
Response
500 — Server Error
Something went wrong on our side. These are rare. How to resolve- Retry the request after a short delay.
- If the error persists, contact support with the request details so we can investigate.
Response
Before contacting support, double-check your request against the endpoint’s Attributes and the codes above — most errors are resolved by correcting the API key, credits, or parameters.

