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

# نظرة عامة على الواجهة البرمجية

> عنوان URL الأساسي والمصادقة والأخطاء وإعادة المحاولات وحدود المعدّل والترويسات في واجهة Conare البرمجية.

واجهة Conare البرمجية هي JSON عبر HTTPS. لكل نقطة نهاية صفحة في هذا التبويب، مع بيئة تجريب.

| | |
| - | - |
| عنوان URL الأساسي | `https://api.conare.ai` |
| المصادقة | `Authorization: Bearer $CONARE_API_KEY` |
| المفاتيح | تُنشأ في [وحدة التحكم](https://docs.conare.ai/ar/console.md#المفاتيح)؛ احتفظ بها على خادمك |
| أجسام الطلبات | JSON بصيغة snake\_case؛ الحقول غير المعروفة تُرجع `400` |
| المواصفة | [api.conare.ai/openapi.yaml](https://api.conare.ai/openapi.yaml) |

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

تتجاهل المسارات المتوافقة مع OpenAI وCohere (`/v1`، `/v2`) الحقول غير المعروفة.

## الأخطاء

```json theme={null}
{
  "error": {
    "code": "invalid_request",
    "message": "documents[0].text is required",
    "request_id": "45ea7c7353368cb646e5cc2303008072"
  }
}
```

| الحالة | المعنى |
| - | - |
| 400 | الطلب غير صالح؛ يوضّح `message` السبب |
| 401 | المفتاح مفقود أو خاطئ أو ملغى |
| 403 | لا يستطيع المفتاح الوصول إلى مساحة الأسماء هذه أو هذا المسار |
| 404 | غير موجود |
| 409 | تعارض في الإصدار، أو فازت كتابة متزامنة |
| 413 | الجسم أو المستند أو الملف كبير جدًا |
| 415 | نوع [الملف](https://docs.conare.ai/ar/files.md) غير مدعوم |
| 422 | تتعذّر قراءة الملف، أو أُعيد استخدام `Idempotency-Key` لطلب آخر |
| 429 | تجاوز [حد المعدّل](#حدود-المعدّل) |
| 5xx | مشكلة من جانبنا |

## إعادة المحاولات

| الحالة | الإجراء |
| - | - |
| `429`، `503` | أعد المحاولة بعد عدد الثواني في ترويسة `Retry-After` |
| أخطاء 5xx الأخرى | أعد المحاولة مع فترة تراجع |
| الكتابة والحذف | أرسل `Idempotency-Key` (معرّف UUID)؛ التكرار خلال 24 ساعة يُرجع الإجابة الأولى مع `Idempotent-Replayed: true` ولا يغيّر شيئًا |

تعيد [SDK](https://docs.conare.ai/ar/sdk.md) المحاولة وترسل `Idempotency-Key` نيابةً عنك.

## حدود المعدّل

لكل مؤسسة. الدفعات المفاجئة حتى ما يعادل 10 ثوانٍ مقبولة؛ وبعد تجاوز الحد تُرجع الواجهة البرمجية `429` مع `Retry-After`.

| الاستدعاءات | في الثانية | المتزامنة في آنٍ واحد |
| - | - | - |
| البحث | 100 | 128 |
| الكتابة | 100 مستند | 64 |
| التضمين | 100 نص | 16 |
| إعادة الترتيب | 20 | 16 |
| استعلامات [turbopuffer API](https://docs.conare.ai/ar/turbopuffer.md) | 1,000 | |
| كل ما عدا ذلك | 100 | |

## الترويسات

| الترويسة | الاتجاه | المعنى |
| - | - | - |
| `Authorization` | الطلب | `Bearer` ومفتاحك |
| `Idempotency-Key` | الطلب | تجعل إعادة محاولة الكتابة آمنة |
| `X-Conare-Org` | الطلب | المؤسسة التي يُعمل نيابةً عنها، مع مفتاح متعدد المؤسسات ([اسردها](https://docs.conare.ai/ar/api-reference/organizations/list-organizations.md)) |
| `Content-Encoding: gzip` | الطلب | جسم مضغوط؛ تُحتسب الحدود بعد فك ضغطه |
| `X-Request-Id` | الاستجابة | في كل استجابة؛ أدرجه عند التواصل مع الدعم |
| `Retry-After` | الاستجابة | ثوانٍ للانتظار، مع `429` و`503` |
| `Conare-Degraded` | الاستجابة | نجح الطلب دون جزء من عمله، مثل إعادة الترتيب ([القيم](https://docs.conare.ai/ar/query.md#النتائج-المنقوصة)) |
| `Idempotent-Replayed` | الاستجابة | `true` عندما تحصل إعادة المحاولة على الإجابة الأولى |

## الحالة الصحية

لا يحتاج `GET /health/deep` إلى مفتاح: تكون `status` إما `ok` أو `degraded` (كلاهما HTTP 200) أو `down` (HTTP 503).

```json Response theme={null}
{ "status": "ok", "checkedAt": "2026-10-21T21:39:16.729996745Z" }
```


## Related topics

- [turbopuffer API](https://docs.conare.ai/ar/turbopuffer.md)
- [TypeScript SDK](https://docs.conare.ai/ar/sdk.md)
- [وحدة التحكم](https://docs.conare.ai/ar/console.md)
- [المرشّحات](https://docs.conare.ai/ar/filters.md)
- [الملفات](https://docs.conare.ai/ar/files.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.