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 message, hint, and documentation URL 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 Kayle 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 is a you problem.
Name
5xx
Description
A 5xx status code indicates a server error—this is a problem with us.

Error types

Whenever a request is unsuccessful, the Kayle API will return an error response with a message, hint, and documentation URL.

You can use this information to understand better what has gone wrong and how to fix it.

404 Error Response

{
  "hint": "This endpoint doesn’t exist.",
  "message": "Check the URL and try again.",
  "docs": "https://kayle.ai/docs"
}