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

# Obter, listar e excluir documentos

> Leia um documento, percorra um namespace página por página e exclua por id ou por filtro.

Para excluir tudo em um namespace, [exclua o namespace](https://docs.conare.ai/pt-BR/namespaces.md#excluir-um-namespace).

## Obter um documento

`GET /namespaces/:namespace/documents/:id`

Retorna um documento com seu texto completo, ou `404 document_not_found`.

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

```ts TypeScript theme={null}
const doc = await docs.get("refunds"); // null if it doesn't exist
```

```json Response theme={null}
{
  "id": "refunds",
  "text": "Refunds are available for 30 days.",
  "metadata": { "team": "support" },
  "updated_at": "2026-10-21T21:38:52Z",
  "version": 1
}
```

| Campo | Significado |
| - | - |
| `id`, `text`, `metadata` | O documento |
| `updated_at` | Quando mudou pela última vez, em UTC |
| `version` | Aumenta a cada alteração |
| `user`, `seq` | Como [gravados](https://docs.conare.ai/pt-BR/write.md), quando definidos |

Schema completo: [Obter um documento](https://docs.conare.ai/pt-br/api-reference/documents/get-a-document.md).

## Listar documentos

`GET /namespaces/:namespace/documents`

Retorna os documentos em ordem de id, sem o texto.

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

```ts TypeScript theme={null}
for await (const doc of docs.list()) {
  console.log(doc.id, doc.version); // reads every page
}
```

```json Response theme={null}
{
  "documents": [
    { "id": "refunds", "metadata": { "team": "support" }, "updated_at": "2026-10-21T21:38:52Z", "version": 1 },
    { "id": "shipping", "metadata": { "team": "ops" }, "updated_at": "2026-10-21T21:38:52Z", "version": 1 }
  ],
  "next_cursor": null
}
```

| Opção | Tipo | O que faz |
| - | - | - |
| `limit` | integer, padrão 50 | Documentos por página, 1-100 |
| `cursor` | string | O `next_cursor` da página anterior, que é `null` na última página |

Schema completo: [Listar documentos](https://docs.conare.ai/pt-br/api-reference/documents/list-documents.md).

## Excluir um documento

`DELETE /namespaces/:namespace/documents/:id`

Exclui um documento, ou retorna `404 document_not_found`.

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

```ts TypeScript theme={null}
await docs.delete("refunds");
```

```json Response theme={null}
{ "deleted": true }
```

Schema completo: [Excluir um documento](https://docs.conare.ai/pt-br/api-reference/documents/delete-a-document.md).

## Excluir vários

`POST /namespaces/:namespace/documents/delete`

Exclui uma lista de ids, ou todos os documentos que um filtro encontra: envie `ids` ou `filter`, não ambos.

```bash curl theme={null}
curl https://api.conare.ai/namespaces/docs/documents/delete \
  -H "Authorization: Bearer $CONARE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids": ["refunds", "shipping"]}'

curl https://api.conare.ai/namespaces/docs/documents/delete \
  -H "Authorization: Bearer $CONARE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"filter": {"team": "support"}}'
```

```ts TypeScript theme={null}
await docs.deleteMany(["refunds", "shipping"]); // how many were deleted
await docs.deleteWhere({ team: "support" });    // repeats until done
```

```json Response theme={null}
{ "deleted": 2, "more": false }
```

| Opção | Tipo | O que faz |
| - | - | - |
| `ids` | array | De 1 a 1.000 ids de documentos; ids inexistentes são ignorados |
| `filter` | object | Um [filtro](https://docs.conare.ai/pt-BR/filters.md), sem `$ne` ou `$nin` |

* `deleted` é quantos documentos esta chamada excluiu.
* Um filtro exclui em lotes: enquanto `more` for `true`, envie-o de novo.

> [!WARNING]
>
> Uma chave de filtro com erro de digitação não encontra nada, então nada é excluído.

Schema completo: [Excluir documentos por id ou filtro](https://docs.conare.ai/pt-br/api-reference/documents/delete-documents-by-id-or-filter.md).


## Related topics

- [Namespaces](https://docs.conare.ai/pt-BR/namespaces.md)
- [Fontes](https://docs.conare.ai/pt-BR/sources.md)
- [Início rápido](https://docs.conare.ai/pt-BR/quickstart.md)
- [MCP](https://docs.conare.ai/pt-BR/mcp-server.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.