Errors

In this guide, we will talk about what happens when something goes wrong while you work with the API. 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).

Status codes

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

  • Name
    2xx
    Type
    Description

    A 2xx status code indicates a successful response.

  • Name
    4xx
    Type
    Description

    A 4xx status code indicates a client error — you might be able to fix this problem.

  • Name
    5xx
    Type
    Description

    A 5xx status code indicates a server error — this is probably our fault.

Error types

Whenever a request is unsuccessful, the FAVOR 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 FAVOR API.

  • Name
    api_error
    Type
    Description

    This means that something went wrong on our end

  • Name
    invalid_request
    Type
    Description

    This means that something went wrong on your end

Error response

{
  "type": "api_error",
  "message": "No way this is happening!?",
}