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

> Il pacchetto conare per TypeScript e JavaScript: namespace, ricerca, file, modelli e sorgenti.

`conare` incapsula l'API per Node 18 o successivo e Bun, senza dipendenze.

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

I campi delle risposte sono in camelCase, e i timestamp sono `Date`.

## Opzioni

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

Ogni metodo accetta anche `{ signal, timeout, idempotencyKey }` come ultimo argomento.

## Metodi

| Metodo | Restituisce |
| - | - |
| `conare.namespace(name)` | Un handle del namespace; nulla viene inviato finché non chiami un metodo |
| `conare.namespaces({ prefix })` | `[{ name, documents, embeddingModel, rerankModel }]` |
| `ns.add(docs)` | Gli id |
| `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 iteratore asincrono di pagine |
| `ns.get(id)` | Il documento, oppure `null` |
| `ns.list({ limit })` | Un iteratore asincrono su tutti i documenti |
| `ns.delete(id)` | Nulla |
| `ns.deleteMany(ids)`, `ns.deleteWhere(filter)` | Quanti ne sono stati eliminati |
| `ns.create({ embeddingModel })` | `{ embeddingModel }` |
| `ns.drop({ force })` | `{ sourcesDeleted }` |
| `ns.uploadFile(file, name, { id, type, user, metadata, pages, password, layout, wait })` | Il [caricamento](https://docs.conare.ai/it/files.md#caricare-un-file) e, una volta `ready`, il suo Markdown |
| `ns.getFile(fileId, { user })` | L'ultimo [caricamento](https://docs.conare.ai/it/files.md#controllare-un-file) del file |
| `conare.parse(file or { url }, { name, type, pages, password, layout, wait })` | Il [Markdown](https://docs.conare.ai/it/files.md#analizzare-un-file) del file, senza salvare nulla |
| `conare.getParse(id)` | Un parse che ha risposto `parsing` |
| `conare.embed(texts, { type, outputDtype })` | I vettori; con `int8`, `{ values, scales }` (`dequantize` li riconverte) |
| `conare.rerank(query, documents, { topK })` | `[{ index, score, document }]`, con `unscored` |
| `conare.sources` | `connect`, `create`, `list`, `get`, `sync`, `update`, `delete`, `types` |
| `conare.organizations()` | Le organizzazioni per cui agisce la chiave |
| `conare.users.delete(user)`, `deletePrefix(prefix)` | L'esecuzione che elimina i dati di un utente |
| `conare.events.list({ cursor, types })` | Cosa è cambiato, in ordine |

* `add` e `write` accettano un documento o un array di qualsiasi dimensione, e ne inviano 100 alla volta.
* La ricerca in tutti i namespace (`POST /query`) e `answer` non hanno ancora un metodo: chiamali via HTTP.

## Errori

Ogni errore lancia un `ConareError` con `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 |
| - | - |
| Nessuna risposta | `status` è `0`, `code` è `timeout` o `connection_error` |
| `429`, `5xx`, errori di rete | Ritentati fino a `maxRetries` volte, dopo `Retry-After` o un backoff |
| Scritture | Includono un [`Idempotency-Key`](https://docs.conare.ai/it/api#nuovi-tentativi), quindi un nuovo tentativo non scrive mai due volte |


## Related topics

- [Guida rapida](https://docs.conare.ai/it/quickstart.md)
- [Introduzione](https://docs.conare.ai/it/index.md)
- [Embedding e reranking](https://docs.conare.ai/it/embed-rerank.md)
- [API turbopuffer](https://docs.conare.ai/it/turbopuffer.md)
- [Ricerca](https://docs.conare.ai/it/query.md)


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