> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orbb.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Errors

> The shape of an error, which field to branch on, and the order calls are checked in.

An error answer has a 4xx or 5xx status and a JSON body:

```json theme={null}
{"error":"invalid_limit","detail":"The limit value was refused.","request_id":"6720f0c2a1b2c3d4e5f60718"}
```

`error` is the code: it is stable, and it is what a client branches on. `detail` is a sentence for a person to read; its wording can change, so it is never parsed. `request_id` equals the `X-Request-Id` header. A `422 ambiguous_person` body also carries `candidates`.

Each operation lists the codes it answers, grouped by status, with when each is answered and what to do.

A request field’s entry opens with its type and range, and the code a value outside them is answered. Whatever the field, a value of the wrong JSON type, a string or an array longer than its maximum, an unknown field, a missing required field, or a combination of fields the operation does not take is answered `400 invalid_body`; the entries do not repeat it.

A call is checked in this order, and answered with the first refusal: the body is parsed (`400 invalid_body`), the token (`401`), the rate limits (`429 rate_limited`, `429 too_many_concurrent`), then the fields of the body, in the order each operation gives. A resolve, or a call with `on_miss: RESEARCH`, is then checked against the research and resolve jobs still running (`429 research_busy`); every call that starts a job, against the balance (`402`).

An unknown path, or a known path with another method, is answered `404 not_found`.

`503 unavailable` means the API could not complete the call. A call that starts a job and is answered `503` has no answer to come: send it again, backing off. On a poll, see Jobs.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.