> For the complete documentation index, see [llms.txt](https://docs.clym.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.clym.io/getting-started/error-handling.md).

# Error handling

Clym uses conventional HTTP response codes to indicate the success or failure of an API request. Status codes in the `2xx` range indicate success, status codes in the `4xx` range indicate an error on your side, while status codes in the `5xx` range indicate an error on our side.

The error object returned usually has the following pattern.

```json
{
    "error": {
        "code": "DATA.INVALID_NAME",
        "ns": "DATA",
        "message": "The specified name is not valid",
        "status": 400,
        "data": {
            "field": "name"
        }
    }
}
```

* `code` represents the error code, always in uppercase
* `ns`  represents the namespace of that error, such as `DATA` or `PARTNER`  or `INSTANCE` 
* `message` represents additional information about the error that occurred
* `status` represents the HTTP status code returned
* `data` represents additional structured information about the error.


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.clym.io/getting-started/error-handling.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.