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

> Le package conare pour TypeScript et JavaScript : namespaces, recherche, fichiers, modèles et sources.

`conare` encapsule l'API pour Node 18 ou plus et Bun, sans dépendances.

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

Les champs de réponse sont en camelCase, et les horodatages sont des `Date`.

## Options

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

Chaque méthode accepte aussi `{ signal, timeout, idempotencyKey }` en dernier argument.

## Méthodes

| Méthode | Renvoie |
| - | - |
| `conare.namespace(name)` | Un handle de namespace ; rien n'est envoyé avant l'appel d'une méthode |
| `conare.namespaces({ prefix })` | `[{ name, documents, embeddingModel, rerankModel }]` |
| `ns.add(docs)` | Les 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, ... })` | Un itérateur asynchrone de pages |
| `ns.get(id)` | Le document, ou `null` |
| `ns.list({ limit })` | Un itérateur asynchrone sur tous les documents |
| `ns.delete(id)` | Rien |
| `ns.deleteMany(ids)`, `ns.deleteWhere(filter)` | Le nombre de documents supprimés |
| `ns.create({ embeddingModel })` | `{ embeddingModel }` |
| `ns.drop({ force })` | `{ sourcesDeleted }` |
| `ns.uploadFile(file, name, { id, type, user, metadata, pages, password, layout, wait })` | L'[upload](https://docs.conare.ai/fr/files.md#importer-un-fichier) et, une fois `ready`, son Markdown |
| `ns.getFile(fileId, { user })` | Le dernier [upload](https://docs.conare.ai/fr/files.md#vérifier-un-fichier) du fichier |
| `conare.parse(file or { url }, { name, type, pages, password, layout, wait })` | Le [Markdown](https://docs.conare.ai/fr/files.md#convertir-un-fichier) du fichier, sans rien stocker |
| `conare.getParse(id)` | Un parsing qui a répondu `parsing` |
| `conare.embed(texts, { type, outputDtype })` | Les vecteurs ; avec `int8`, `{ values, scales }` (`dequantize` les reconvertit) |
| `conare.rerank(query, documents, { topK })` | `[{ index, score, document }]`, avec `unscored` |
| `conare.sources` | `connect`, `create`, `list`, `get`, `sync`, `update`, `delete`, `types` |
| `conare.organizations()` | Les organisations pour lesquelles la clé agit |
| `conare.users.delete(user)`, `deletePrefix(prefix)` | L'exécution qui supprime les données d'un utilisateur |
| `conare.events.list({ cursor, types })` | Ce qui a changé, dans l'ordre |

* `add` et `write` acceptent un document ou un tableau de toute taille, et envoient par lots de 100.
* La recherche dans tous les namespaces (`POST /query`) et `answer` n'ont pas encore de méthode : appelez-les en HTTP.

## Erreurs

Chaque échec lève une `ConareError` avec `status`, `code`, `message` et `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"
}
```

| Cas | Comportement |
| - | - |
| Aucune réponse | `status` vaut `0`, `code` vaut `timeout` ou `connection_error` |
| `429`, `5xx`, erreurs réseau | Réessayées jusqu'à `maxRetries` fois, après `Retry-After` ou un backoff |
| Écritures | Portent une [`Idempotency-Key`](https://docs.conare.ai/fr/api#nouvelles-tentatives), donc une nouvelle tentative n'écrit jamais deux fois |


## Related topics

- [Démarrage rapide](https://docs.conare.ai/fr/quickstart.md)
- [Introduction](https://docs.conare.ai/fr/index.md)
- [Embedding et reranking](https://docs.conare.ai/fr/embed-rerank.md)
- [API turbopuffer](https://docs.conare.ai/fr/turbopuffer.md)
- [Recherche](https://docs.conare.ai/fr/query.md)


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