Obter, listar e excluir documentos

Para excluir tudo em um namespace, exclua o namespace.

Obter um documento

GET /namespaces/:namespace/documents/:id Retorna um documento com seu texto completo, ou 404 document_not_found.

curl https://api.conare.ai/namespaces/docs/documents/refunds \
  -H "Authorization: Bearer $CONARE_API_KEY"

const doc = await docs.get("refunds"); // null if it doesn't exist

Response

{
  "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, quando definidos

Schema completo: Obter um documento.

Listar documentos

GET /namespaces/:namespace/documents Retorna os documentos em ordem de id, sem o texto.

curl "https://api.conare.ai/namespaces/docs/documents?limit=100" \
  -H "Authorization: Bearer $CONARE_API_KEY"

for await (const doc of docs.list()) {
  console.log(doc.id, doc.version); // reads every page
}

Response

{
  "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.

Excluir um documento

DELETE /namespaces/:namespace/documents/:id Exclui um documento, ou retorna 404 document_not_found.

curl -X DELETE https://api.conare.ai/namespaces/docs/documents/refunds \
  -H "Authorization: Bearer $CONARE_API_KEY"

await docs.delete("refunds");

Response

{ "deleted": true }

Schema completo: Excluir um documento.

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.

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"}}'

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

Response

{ "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, sem `$ne` ou `$nin`

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

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.

Primeiros passos

Essencial

Arquivos

Sincronização

Modelos

Ferramentas

Obter, listar e excluir documentos

Obter um documento

Listar documentos

Excluir um documento

Excluir vários

​Obter um documento

​Listar documentos

​Excluir um documento

​Excluir vários

Obter um documento

Listar documentos

Excluir um documento

Excluir vários