Quincy

Errors

In this guide, we will talk about what happens when something goes wrong while you work with the API. Understanding error handling will help you build more robust integrations with our platform.

You can determine if your request was successful by checking the status code in the API response. For unsuccessful responses, the error type and message will help you identify and resolve the issue.

If you need any support at any time, please don't hesitate to contact us at [email protected].

Status codes

Here are the status code categories returned by the Quincy API:

  • Name
    2xx
    Description
    Indicates a successful response.
  • Name
    4xx
    Description

    Indicates a client error - an issue with the request.

  • Name
    5xx
    Description

    Indicates a server error - an issue on our end.

Error types

When a request fails, the Quincy API returns an error response containing an error type and message. This information helps identify the cause and potential solution.

The API uses two main error types:

  • Name
    api_error
    Description

    Indicates an internal API error on our side.

  • Name
    invalid_request
    Description

    Indicates an issue with the request parameters or format.

Error response

{
  "type": "api_error",
  "message": "An unexpected error occurred",
}