获取、列出和删除文档

要删除命名空间中的所有内容，请删除该命名空间。

获取文档

GET /namespaces/:namespace/documents/:id 返回包含完整文本的单个文档，或返回 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
}

字段	含义
`id`, `text`, `metadata`	文档本身
`updated_at`	最后一次变更的时间（UTC）
`version`	每次变更时递增
`user`, `seq`	设置时，与写入时一致

完整 schema：获取文档。

列出文档

GET /namespaces/:namespace/documents 按 id 顺序返回文档，不含文本。

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
}

选项	类型	作用
`limit`	integer，默认 50	每页文档数，1-100
`cursor`	string	上一页的 `next_cursor`，最后一页时为 `null`

完整 schema：列出文档。

删除文档

DELETE /namespaces/:namespace/documents/:id 删除单个文档，或返回 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：删除文档。

批量删除

POST /namespaces/:namespace/documents/delete 删除一组 id，或删除过滤条件匹配的所有文档：发送 ids 或 filter，不能同时发送。

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 }

选项	类型	作用
`ids`	array	1-1,000 个文档 id；不存在的 id 会被跳过
`filter`	object	过滤条件，不支持 `$ne` 或 `$nin`

deleted 表示本次调用删除的数量。
过滤条件会分批删除：只要 more 为 true，就再次发送请求。

拼写错误的过滤键不会匹配任何内容，因此不会删除任何文档。

完整 schema：按 id 或过滤条件删除文档。

快速开始

核心

文件

同步

模型

工具

获取、列出和删除文档

获取文档

列出文档

删除文档

批量删除

​获取文档

​列出文档

​删除文档

​批量删除

获取文档

列出文档

删除文档

批量删除