Our API categorizes errors into two different and very distinct types:
Client Side Errors
--> 4xx errorsServer Side Errors
--> 5xx errorsFailed Requests
Please note that we do not charge the user for the execution of failed requests. Only successful requests count toward your credit budget.
When a request first lands at our servers, we make a number of security, authentication and data validation checks. If any of these fail, a Client Side Error
is generated with a message detailing the error that took place.
An example would be forgetting to set the X-API-KEY
header which is required to authenticate the request. Another example would be providing invalid input data to one of the endpoint parameters.
Server Side Errors
often indicate incorrect execution of the request based on the provided user input. In order to protect our servers from malicious use, we have strict rules in place that halt execution. All of these requests are responded to with a 500 HTTP code
. If you encounter such an error, you may report it to us for closer inspection using one of our customer support channels: Contact Page, Twitter, or Discord.
Code | Status | Description |
---|---|---|
200 | Ok | Request was successful |
400 | Bad Request | Issued when a request is incomplete or contains badly formatted input data |
401 | Unauthorized | Issued when authentication data such as X-API-Key is not properly provided |
402 | Payment Required | Issued when the account does not have sufficient funds --> See our Pricing Page |
403 | Forbidden | Issued when trying to access a resource for which you do not have permission |
404 | Not Found | Issued when the request is trying to reach an endpoint that does not exist |
405 | Method Not Allowed | Issued when the request is using the incorrect HTTP verb. Our endpoints mostly use GET and POST |
429 | Too Many Requests | Issued when the account exceeds its allowed rate limits |
500 | Server Side Error | Issued when the server halts execution |
503 | Service Unavailable | Issued when the API or endpoint is down for maintenance |