> For the complete documentation index, see [llms.txt](https://help.mimeeq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.mimeeq.com/api/errors.md).

# Errors

API errors normally use this JSON envelope:

```
{ "code": "error_code", "message": "Readable explanation", "requestId": "request-id" }
```

Some errors also include `details`, for example field validation failures. Use the HTTP status and `code` to decide how to respond; keep `requestId`, the endpoint and request time when reporting a problem. Do not include your API key in a support report.

| Status    | Meaning                                                        | Next step                                                            |
| --------- | -------------------------------------------------------------- | -------------------------------------------------------------------- |
| 400 / 422 | Invalid input or an unsupported operation for this record      | Check the response code, details and request schema before retrying. |
| 401       | Missing or invalid API key                                     | Check the Authorization header and key.                              |
| 403       | Missing scope or an operation not allowed for the account      | Check the key's scopes and resource restrictions.                    |
| 404       | The resource was not found or is not available to this account | Check the ID and account context.                                    |
| 409       | A conflicting record or state                                  | Read the existing resource before retrying.                          |
| 429       | Request rate or monthly allowance exceeded                     | Follow Retry-After and the rate-limit guidance below.                |
| 500 / 503 | Server error or temporary unavailability                       | Preserve request details; follow Retry-After when provided.          |

Edge firewall rejections occur before the request reaches the API. An IP rate-limit rejection returns `429 rate_limit_exceeded` without `requestId`. A blocked attack pattern or an IP reputation rule can return `403` with a non-JSON body. Report the endpoint and request time for these cases.


---

# 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://help.mimeeq.com/api/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.