> ## 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.

> ## Agent Instructions
> Conare's API is at https://api.conare.ai. Authenticate with `Authorization: Bearer $CONARE_API_KEY`.
> The full OpenAPI spec is at https://api.conare.ai/openapi.yaml; each endpoint has a page under /api-reference, and appending .md to any page URL returns its Markdown.
> Embed with model conare-embed-1; send input_type "query" for search queries. Rerank with conare-rerank-1.
> Prefer the TypeScript SDK (`npm install conare`) or plain HTTP in examples.
> Install the Conare skill with `npx skills add https://docs.conare.ai`; search these docs over MCP at https://docs.conare.ai/mcp; the whole site is at https://docs.conare.ai/llms-full.txt.

# Огляд API

> Базова URL-адреса, автентифікація, помилки, повтори, обмеження частоти й заголовки Conare API.

Conare API — це JSON через HTTPS. Кожна кінцева точка має сторінку в цій вкладці з пісочницею.

| | |
| - | - |
| Базова URL-адреса | `https://api.conare.ai` |
| Автентифікація | `Authorization: Bearer $CONARE_API_KEY` |
| Ключі | Створюються в [консолі](https://docs.conare.ai/uk/console.md#ключі); зберігайте їх на своєму сервері |
| Тіла запитів | JSON, snake\_case; невідомі поля дають `400` |
| Специфікація | [api.conare.ai/openapi.yaml](https://api.conare.ai/openapi.yaml) |

```bash theme={null}
curl https://api.conare.ai/namespaces \
  -H "Authorization: Bearer $CONARE_API_KEY"
```

Маршрути, сумісні з OpenAI і Cohere (`/v1`, `/v2`), ігнорують невідомі поля.

## Помилки

```json theme={null}
{
  "error": {
    "code": "invalid_request",
    "message": "documents[0].text is required",
    "request_id": "45ea7c7353368cb646e5cc2303008072"
  }
}
```

| Статус | Значення |
| - | - |
| 400 | Запит недійсний; `message` пояснює чому |
| 401 | Ключ відсутній, неправильний або відкликаний |
| 403 | Ключ не має доступу до цього простору імен чи маршруту |
| 404 | Не знайдено |
| 409 | Конфлікт версій, або переміг паралельний запис |
| 413 | Тіло, документ або файл завеликі |
| 415 | Тип [файлу](https://docs.conare.ai/uk/files.md) не підтримується |
| 422 | Файл неможливо прочитати, або `Idempotency-Key` повторно використано для іншого запиту |
| 429 | Перевищено [обмеження частоти](#обмеження-частоти) |
| 5xx | Проблема на нашому боці |

## Повтори

| Випадок | Що робити |
| - | - |
| `429`, `503` | Повторіть через кількість секунд із заголовка `Retry-After` |
| Інші 5xx | Повторіть із затримкою |
| Записи й видалення | Надсилайте `Idempotency-Key` (UUID); повтор протягом 24 годин повертає першу відповідь з `Idempotent-Replayed: true` і нічого не змінює |

[SDK](https://docs.conare.ai/uk/sdk.md) повторює запити й надсилає `Idempotency-Key` за вас.

## Обмеження частоти

На організацію. Сплески обсягом до 10 секунд допустимі; після перевищення обмеження API повертає `429` з `Retry-After`.

| Виклики | За секунду | Одночасно в обробці |
| - | - | - |
| Пошук | 100 | 128 |
| Запис | 100 документів | 64 |
| Ембединги | 100 текстів | 16 |
| Переранжування | 20 | 16 |
| Запити [turbopuffer API](https://docs.conare.ai/uk/turbopuffer.md) | 1 000 | |
| Усе інше | 100 | |

## Заголовки

| Заголовок | Напрямок | Значення |
| - | - | - |
| `Authorization` | Запит | `Bearer` і ваш ключ |
| `Idempotency-Key` | Запит | Робить запис безпечним для повтору |
| `X-Conare-Org` | Запит | Організація, від імені якої діяти, з ключем для кількох організацій ([перелік](https://docs.conare.ai/uk/api-reference/organizations/list-organizations.md)) |
| `Content-Encoding: gzip` | Запит | Стиснене тіло; ліміти рахуються за розпакованим |
| `X-Request-Id` | Відповідь | У кожній відповіді; додавайте його, коли звертаєтеся в підтримку |
| `Retry-After` | Відповідь | Скільки секунд чекати, для `429` і `503` |
| `Conare-Degraded` | Відповідь | Запит виконано без частини роботи, як-от переранжування ([значення](https://docs.conare.ai/uk/query.md#неповні-результати)) |
| `Idempotent-Replayed` | Відповідь | `true`, коли повтор отримав першу відповідь |

## Стан

`GET /health/deep` не потребує ключа: `status` дорівнює `ok`, `degraded` (обидва HTTP 200) або `down` (HTTP 503).

```json Response theme={null}
{ "status": "ok", "checkedAt": "2026-10-21T21:39:16.729996745Z" }
```


## Related topics

- [turbopuffer API](https://docs.conare.ai/uk/turbopuffer.md)
- [Embed texts (OpenAI-compatible)](https://docs.conare.ai/uk/api-reference/models/embed-texts-openai-compatible.md)
- [Rerank documents (Cohere- and vLLM-compatible)](https://docs.conare.ai/uk/api-reference/models/rerank-documents-cohere-and-vllm-compatible.md)
- [Rerank documents (Cohere v2-compatible)](https://docs.conare.ai/uk/api-reference/models/rerank-documents-cohere-v2-compatible.md)
- [Connect a source](https://docs.conare.ai/uk/api-reference/sources/connect-a-source.md)


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