Skip to main content

HTTP Status Codes

Here are the common HTTP status codes you might encounter: 200 OK: The request was successful. 201 Created: The request was successful, and a new resource was created. 204 No Content: The request was successful, but there is no content to return (e.g., a successful deletion). 400 Bad Request: The request was malformed or invalid (e.g., missing required parameters, invalid JSON format). 401 Unauthorized: Authentication failed or was not provided (e.g., missing or invalid X-API-KEY). 403 Forbidden: The authenticated user does not have the necessary permissions to access the resource or perform the action. 404 Not Found: The requested resource could not be found. 405 Method Not Allowed: The HTTP method used is not supported for the requested resource (e.g., trying to POST to a GET-only endpoint). 429 Too Many Requests: You have exceeded the API’s rate limits. 500 Internal Server Error: A generic error occurred on our server. This usually indicates an unexpected issue on our end.

Error Response Structure

When an error occurs (typically for 4xx or 5xx status codes), our API will return a JSON object with the following structure:
error: A concise message explaining what went wrong.

Handling Errors in Your Code

It’s good practice to check the HTTP status code of the response and parse the error body to provide meaningful feedback to your users or for debugging.

Using Python

Using JavaScript (Browser fetch)

Authentication

This endpoint requires an API key. You can retrieve an API key from your dashboard. Include it in the X-API-KEY header:
For more details, see the Authentication Guide.

Need Further Assistance?

If you have any questions or encounter issues, please don’t hesitate to reach out to our support team.