Errors

In this guide, we will talk about what happens when something goes wrong while you work with the API. Mistakes happen, and mostly they will be yours, not ours. Let's look at some status codes and error types you might encounter.

You can tell if your request was successful by checking the status code when receiving an API response. If a response comes back unsuccessful, you can use the error type and error message to figure out what has gone wrong and do some rudimentary debugging (before contacting support).

Before reaching out to support with an error, please be aware that 99% of all reported errors are, in fact, user errors. Therefore, please carefully check your code before contacting Supesa support.

Status codes

Here is a list of the different categories of status codes returned by the Supesa API. Use these to understand if a request was successful.

Name
2xx
Description
A 2xx status code indicates a successful response.
Name
4xx
Description
A 4xx status code indicates a client error — this means it's a you problem.
Name
5xx
Description
A 5xx status code indicates a server error — you (hopefully) won't be seeing these.

Error types

Whenever a request is unsuccessful, the Supesa API will return an error response with an error type and message. You can use this information to understand better what has gone wrong and how to fix it. Most of the error messages are pretty helpful and actionable.

Here is a list of the two error types supported by the Supesa API — use these to understand what you have done wrong.

Name
loc
Description
The error and it's relative location
Name
msg
Description
The reported error
Name
type
Description
The type of error

Error response

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "Houston, we have a problem",
      "type": "input_validation"
    }
  ]
}