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

# SDK TypeScript

> O pacote conare para TypeScript e JavaScript: namespaces, busca, arquivos, modelos e fontes.

`conare` encapsula a API para Node 18 ou posterior e Bun, sem dependências.

```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": {}
  }
]
```

Os campos da resposta são camelCase, e os timestamps são `Date`s.

## Opções

```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
});
```

Todo método também aceita `{ signal, timeout, idempotencyKey }` por último.

## Métodos

| Método | Retorna |
| - | - |
| `conare.namespace(name)` | Um handle de namespace; nada é enviado até você chamar um método |
| `conare.namespaces({ prefix })` | `[{ name, documents, embeddingModel, rerankModel }]` |
| `ns.add(docs)` | Os ids |
| `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, ... })` | Um iterador assíncrono de páginas |
| `ns.get(id)` | O documento, ou `null` |
| `ns.list({ limit })` | Um iterador assíncrono sobre todos os documentos |
| `ns.delete(id)` | Nada |
| `ns.deleteMany(ids)`, `ns.deleteWhere(filter)` | Quantos foram excluídos |
| `ns.create({ embeddingModel })` | `{ embeddingModel }` |
| `ns.drop({ force })` | `{ sourcesDeleted }` |
| `ns.uploadFile(file, name, { id, type, user, metadata, pages, password, layout, wait })` | O [upload](https://docs.conare.ai/pt-BR/files.md#enviar-um-arquivo) e, quando `ready`, seu Markdown |
| `ns.getFile(fileId, { user })` | O [upload](https://docs.conare.ai/pt-BR/files.md#verificar-um-arquivo) mais recente do arquivo |
| `conare.parse(file or { url }, { name, type, pages, password, layout, wait })` | O [Markdown](https://docs.conare.ai/pt-BR/files.md#converter-um-arquivo) do arquivo, sem armazenar nada |
| `conare.getParse(id)` | Um parse que respondeu `parsing` |
| `conare.embed(texts, { type, outputDtype })` | Os vetores; com `int8`, `{ values, scales }` (`dequantize` os converte de volta) |
| `conare.rerank(query, documents, { topK })` | `[{ index, score, document }]`, com `unscored` |
| `conare.sources` | `connect`, `create`, `list`, `get`, `sync`, `update`, `delete`, `types` |
| `conare.organizations()` | As organizações em nome das quais a chave atua |
| `conare.users.delete(user)`, `deletePrefix(prefix)` | A execução que exclui os dados de um usuário |
| `conare.events.list({ cursor, types })` | O que mudou, em ordem |

* `add` e `write` aceitam um documento ou um array de qualquer tamanho, e enviam 100 por vez.
* A busca em todos os namespaces (`POST /query`) e `answer` ainda não têm método: chame-os via HTTP.

## Erros

Toda falha lança um `ConareError` com `status`, `code`, `message` e `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"
}
```

| Caso | Comportamento |
| - | - |
| Sem resposta | `status` é `0`, `code` é `timeout` ou `connection_error` |
| `429`, `5xx`, erros de rede | Repetidos até `maxRetries` vezes, após `Retry-After` ou um backoff |
| Gravações | Levam um [`Idempotency-Key`](https://docs.conare.ai/pt-BR/api#novas-tentativas), então uma nova tentativa nunca grava duas vezes |


## Related topics

- [Início rápido](https://docs.conare.ai/pt-BR/quickstart.md)
- [Introdução](https://docs.conare.ai/pt-BR/index.md)
- [Embeddings e reranking](https://docs.conare.ai/pt-BR/embed-rerank.md)
- [turbopuffer API](https://docs.conare.ai/pt-BR/turbopuffer.md)
- [Busca](https://docs.conare.ai/pt-BR/query.md)


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