> For the complete documentation index, see [llms.txt](https://developers.didomi.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.didomi.io/api-and-platform/introduction/errors.md).

# Errors

The Didomi API uses standard HTTP response codes to indicate that an API request is a success or a failure. In general, the codes act as follows:

* `2xx` codes indicate a success
* `4xx` codes indicate an error in the parameters sent to the server (e.g., the authentication information is invalid, a required parameter is missing, etc.)
* `5xx` codes indicate a Didomi server-side error

When an error happens, you can look at the JSON response body to find more about the reason. The body will be an object with the following properties:

| Property  | Description                                                                   | Example                            |
| --------- | ----------------------------------------------------------------------------- | ---------------------------------- |
| `code`    | The HTTP response code                                                        | 400                                |
| `name`    | The name of the error (tied to the response code)                             | BadRequest                         |
| `message` | An explanation of the error                                                   | Invalid authentication information |
| `errors`  | An array containing more errors if multiple errors have been batched together |                                    |

Example:

```javascript
{
    "code": 400,
    "errors": {},
    "message": "Invalid authentication information",
    "name": "BadRequest"
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developers.didomi.io/api-and-platform/introduction/errors.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.