Errors

In this guide, we will talk about what happens when something goes wrong while working with the API. Mistakes happen; 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 API. Use these to understand if a request was successful.

Error types

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

Error status

Here is a list of the error types supported by the Bodyguard.ai API — use these to understand what is wrong.

Error example

{
	"error": {
		"message": "Please check your parameters",
		"status": "BAD_REQUEST",
		"code": 400,
		"details": ["'contents' must be an array"]
	}
}