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

# TypeScript SDK

> Пакет conare для TypeScript і JavaScript: простори імен, пошук, файли, моделі та джерела.

`conare` обгортає API для Node 18 і новіших версій та Bun, без залежностей.

```bash theme={null}
npm install conare
```

```ts theme={null}
import { Conare } from "conare";

const conare = new Conare(); // reads CONARE_API_KEY
const docs = conare.namespace("docs");

await docs.add({ text: "Refunds are available for 30 days." });
const results = await docs.query("how do refunds work?");
```

```json Result theme={null}
[
  {
    "id": "doc_HmsFWqbQQc2mY03FhVZE",
    "text": "Refunds are available for 30 days.",
    "score": 0.3192,
    "reranked": true,
    "metadata": {}
  }
]
```

Поля відповіді записано в camelCase, а позначки часу є об’єктами `Date`.

## Параметри

```ts theme={null}
new Conare({
  apiKey: "sk-conare-...",           // default: CONARE_API_KEY
  baseURL: "https://api.conare.ai",  // default: CONARE_BASE_URL
  timeout: 60_000,                   // ms per attempt
  maxRetries: 2,
  organization: "org_...",           // for a multi-organization key
});
```

Кожен метод також приймає останнім аргументом `{ signal, timeout, idempotencyKey }`.

## Методи

| Метод | Повертає |
| - | - |
| `conare.namespace(name)` | Дескриптор простору імен; нічого не надсилається, доки ви не викличете метод |
| `conare.namespaces({ prefix })` | `[{ name, documents, embeddingModel, rerankModel }]` |
| `ns.add(docs)` | Ідентифікатори |
| `ns.write(docs)` | `[{ id, version, result, chunks, chunksEmbedded }]` |
| `ns.query(query, { topK, filter, rerank, rerankDepth, retrievers, user, userPrefix, excludeIds, hops })` | `[{ id, text, score, reranked, metadata }]` |
| `ns.queryPages(query, { maxResults, ... })` | Асинхронний ітератор сторінок |
| `ns.get(id)` | Документ або `null` |
| `ns.list({ limit })` | Асинхронний ітератор по всіх документах |
| `ns.delete(id)` | Нічого |
| `ns.deleteMany(ids)`, `ns.deleteWhere(filter)` | Скільки видалено |
| `ns.create({ embeddingModel })` | `{ embeddingModel }` |
| `ns.drop({ force })` | `{ sourcesDeleted }` |
| `ns.uploadFile(file, name, { id, type, user, metadata, pages, password, layout, wait })` | [Завантаження](https://docs.conare.ai/uk/files.md#завантаження-файлу) і, коли воно `ready`, його Markdown |
| `ns.getFile(fileId, { user })` | Останнє [завантаження](https://docs.conare.ai/uk/files.md#перевірка-файлу) файлу |
| `conare.parse(file or { url }, { name, type, pages, password, layout, wait })` | [Markdown](https://docs.conare.ai/uk/files.md#розбір-файлу) файлу, нічого не зберігається |
| `conare.getParse(id)` | Розбір, який відповів `parsing` |
| `conare.embed(texts, { type, outputDtype })` | Вектори; з `int8` — `{ values, scales }` (`dequantize` перетворює їх назад) |
| `conare.rerank(query, documents, { topK })` | `[{ index, score, document }]`, з `unscored` |
| `conare.sources` | `connect`, `create`, `list`, `get`, `sync`, `update`, `delete`, `types` |
| `conare.organizations()` | Організації, від імені яких діє ключ |
| `conare.users.delete(user)`, `deletePrefix(prefix)` | Запуск, що видаляє дані користувача |
| `conare.events.list({ cursor, types })` | Що змінилося, по порядку |

* `add` і `write` приймають один документ або масив будь-якого розміру й надсилають по 100 за раз.
* Пошук у всіх просторах імен (`POST /query`) і `answer` поки не мають методу: викликайте їх через HTTP.

## Помилки

Кожна помилка викидає `ConareError` з `status`, `code`, `message` і `requestId`.

```ts theme={null}
import { ConareError } from "conare";

try {
  await docs.add({ text: "" });
} catch (err) {
  if (err instanceof ConareError) console.log(err.status, err.code); // 400 "invalid_request"
}
```

| Випадок | Поведінка |
| - | - |
| Немає відповіді | `status` дорівнює `0`, `code` — `timeout` або `connection_error` |
| `429`, `5xx`, мережеві помилки | Повторюються до `maxRetries` разів, після `Retry-After` або затримки |
| Записи | Містять [`Idempotency-Key`](https://docs.conare.ai/uk/api#повтори), тож повтор ніколи не записує двічі |


## Related topics

- [Вступ](https://docs.conare.ai/uk/index.md)
- [Швидкий старт](https://docs.conare.ai/uk/quickstart.md)
- [Ембединги й переранжування](https://docs.conare.ai/uk/embed-rerank.md)
- [turbopuffer API](https://docs.conare.ai/uk/turbopuffer.md)
- [Пошук](https://docs.conare.ai/uk/query.md)


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