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

# Overview

> Base URL, authentication, errors and limits.

## Base URL

```
https://api.conare.ai
```

## Authentication

Send your API key as a bearer token:

```
Authorization: Bearer sk-conare-...
```

Create keys in the [console](https://conare.ai/console/keys). A key can read and write every
namespace in its organization, so keep it on your server.

## Requests and responses

Bodies are JSON with snake\_case keys. Timestamps are RFC 3339 strings. Every response has an
`X-Request-Id` header.

## Errors

Every error has the same shape:

```json theme={null}
{ "error": { "code": "invalid_request", "message": "text is required", "request_id": "req_8f3a2c" } }
```

| Status | Means |
| - | - |
| 400 | The request is invalid. `message` says why. |
| 401 | The API key is missing, wrong or revoked. |
| 404 | The namespace, document or source does not exist. |
| 413 | A document is larger than 256 KB. |
| 429 | Too many requests. Wait for `Retry-After` seconds. |
| 5xx | Something failed on our side. Retry with backoff. |

Include the `request_id` when you contact us.

## Limits

| | Limit |
| - | - |
| Namespace name | 1-64 characters of `a-z 0-9 _ -` |
| Document id | 1-256 characters of `A-Z a-z 0-9 . _ : -` |
| Document text | 256 KB |
| Metadata | 32 keys; strings, numbers, booleans, arrays of strings |
| Documents per write | 100 |
| `top_k` | 1-100 |

## Health

`GET /health/deep` returns `"status": "ok"` when search works end to end.