جلب المستندات وسردها وحذفها

لحذف كل شيء في مساحة أسماء، احذف مساحة الأسماء.

جلب مستند

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`	كما كُتبت، عند تعيينها

المخطط الكامل: جلب مستند.

سرد المستندات

GET /namespaces/:namespace/documents يُرجع المستندات مرتّبة حسب المعرّف، دون نصوصها.

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` في الصفحة الأخيرة

المخطط الكامل: سرد المستندات.

حذف مستند

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 }

المخطط الكامل: حذف مستند.

حذف عدة مستندات

POST /namespaces/:namespace/documents/delete يحذف قائمة من المعرّفات، أو كل مستند يطابقه عامل تصفية: أرسل 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 معرّف مستند؛ تُتخطّى المعرّفات غير الموجودة
`filter`	object	عامل تصفية، دون `$ne` أو `$nin`

deleted هو عدد ما حذفه هذا الاستدعاء.
يحذف عامل التصفية على دفعات: ما دامت more بقيمة true، أرسله مجددًا.

مفتاح التصفية المكتوب خطأً لا يطابق شيئًا، فلا يُحذف شيء.

المخطط الكامل: حذف المستندات حسب المعرّف أو عامل التصفية.

البدء

الأساسيات

الملفات

المزامنة

النماذج

الأدوات

جلب المستندات وسردها وحذفها

جلب مستند

سرد المستندات

حذف مستند

حذف عدة مستندات

​جلب مستند

​سرد المستندات

​حذف مستند

​حذف عدة مستندات

جلب مستند

سرد المستندات

حذف مستند

حذف عدة مستندات