Obtener, listar y eliminar documentos

Para eliminar todo lo que hay en un namespace, elimina el namespace.

Obtener un documento

GET /namespaces/:namespace/documents/:id Devuelve un documento con su texto completo, o 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`	El documento
`updated_at`	Cuándo cambió por última vez, en UTC
`version`	Aumenta con cada cambio
`user`, `seq`	Tal como se escribieron, si se definieron

Esquema completo: Obtener un documento.

Listar documentos

GET /namespaces/:namespace/documents Devuelve los documentos ordenados por id, sin su 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
}

Opción	Tipo	Qué hace
`limit`	integer, por defecto 50	Documentos por página, 1-100
`cursor`	string	El `next_cursor` de la página anterior, que es `null` en la última página

Esquema completo: Listar documentos.

Eliminar un documento

DELETE /namespaces/:namespace/documents/:id Elimina un documento, o devuelve 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 }

Esquema completo: Eliminar un documento.

Eliminar varios

POST /namespaces/:namespace/documents/delete Elimina una lista de ids, o todos los documentos que coinciden con un filtro: envía ids o filter, no 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 }

Opción	Tipo	Qué hace
`ids`	array	De 1 a 1.000 ids de documentos; los ids inexistentes se omiten
`filter`	object	Un filtro, sin `$ne` ni `$nin`

deleted indica cuántos eliminó esta llamada.
Un filtro elimina por lotes: mientras more sea true, vuelve a enviarlo.

Una clave de filtro mal escrita no coincide con nada, así que no se elimina nada.

Esquema completo: Eliminar documentos por id o filtro.

Primeros pasos

Esenciales

Archivos

Sincronización

Modelos

Herramientas

Obtener, listar y eliminar documentos

Obtener un documento

Listar documentos

Eliminar un documento

Eliminar varios

​Obtener un documento

​Listar documentos

​Eliminar un documento

​Eliminar varios

Obtener un documento

Listar documentos

Eliminar un documento

Eliminar varios