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

# Errors

Northbeam uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted). Codes in the 5xx range indicate an error with Northbeam’s servers. We suggest gracefully handling errors that may be returned by Northbeam.

## Status codes

| Code | Meaning | What it usually means |
| - | - | - |
| `200` | OK | The request succeeded. |
| `400` | Bad Request | Malformed JSON or an invalid value. Check the payload structure. |
| `401` | Unauthorized | Missing or invalid API key / `Data-Client-ID` header. |
| `403` | Forbidden | The credentials are valid but not permitted for this resource. |
| `404` | Not Found | The endpoint or resource does not exist. Check the URL. |
| `429` | Too Many Requests | You have exceeded the rate limit. Retry after a short backoff. |
| `500` | Server Error | An error on Northbeam’s side. Retry later; contact support if it persists. |

## Attributes

**status**: *string*\
The error code.

**response**: *json-encoded string or string*\
For some known or common errors, we will return a json-encoded string that represents an array of objects with an “order\_id”, human readable “message”, and the “json\_path” of the failing attributes. For other errors, we may simple return an error string in a human readable format.

## Common errors

* A 400 "Bad Request" error with no additional error message is normally due to JSON being malformed. Please ensure that you are sending properly formed JSON blobs.
