> ## Documentation Index
> Fetch the complete documentation index at: https://docs.befailproof.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# HTTP API

> قم بالمصادقة على واجهة برمجة التطبيقات العامة Failproof AI Cloud `/v1` واستخدم مرجع النقطة النهائية المُنشأ.

يتم تقديم الواجهة البرمجية العامة تحت `/v1` على أصل لوحة تحكم Failproof AI الخاصة بك.

## إنشاء مفتاح وإجراء طلب

<Tabs>
  <Tab title="Dashboard">
    1. افتح **Administration → Keys**، وحدد **Create key**، واختر أضيق مجموعة أذونات تغطي التكامل.
    2. أضف المنح الفردية فقط عند الحاجة، وأنشئ المفتاح، وانسخ سره لمرة واحدة.
    3. أجرِ طلب اختبار إلى `/v1/sessions` وتأكد من بقاء المفتاح نشطًا في صفحة Keys.
    4. قم بتدوير أو تعطيل المفتاح من قائمة الإجراءات الخاصة به عند تغيير ملكية التكامل.

           <img src="https://mintcdn.com/exosphere/WgPwQzedeDNwJBTy/images/dashboard/key-create.png?fit=max&auto=format&n=WgPwQzedeDNwJBTy&q=85&s=a428bdae79f837471acb66414ff6455b" alt="درج مفتاح API الجديد مع مجموعات الأذونات والمنح الفردية." width="2940" height="1604" data-path="images/dashboard/key-create.png" />

    يظهر درج الإنشاء أعلاه. يظهر السر لمرة واحدة فقط بعد اختيار **create**؛ انسخه قبل إغلاق هذا التأكيد.
  </Tab>

  <Tab title="CLI">
    أنشئ مفتاح قراءة واستخدمه مباشرة مع `fp` أو `curl`:

    ```bash theme={null}
    fp keys create reliability-reader \
      --permission-set read-only

    fp --api-key <key> sessions --since 24h
    ```

    ```bash theme={null}
    curl "https://app.befailproof.ai/v1/sessions?limit=20" \
      -H "Authorization: Bearer $FAILPROOFAI_KEY"
    ```
  </Tab>
</Tabs>

تكون المفاتيح مقتصرة على مجموعة المنظمة والأذونات. يُرجع طلب بدون الإذن المطلوب للنقطة النهائية `403` ويحدد الإذن المفقود.

## اختيار المنظمة

يعمل مفتاح المنظمة على منظمته تلقائيًا. يمكن لمفتاح محدود النطاق على المثيل تحديد منظمة لكل طلب:

<Tabs>
  <Tab title="Dashboard">
    استخدم مبدل المنظمة في رأس لوحة التحكم قبل فتح **Administration → Keys**. تنتمي المفاتيح المُنشأة هناك إلى المنظمة المحددة. أكّد على slug المنظمة في عنوان URL وتفاصيل المفتاح قبل نسخ بيانات الاعتماد إلى الأتمتة.
  </Tab>

  <Tab title="CLI">
    استخدم `--org` قبل الأمر، أو أرسل رأس المنظمة لمفتاح API محدود النطاق على المثيل.

    ```bash theme={null}
    fp orgs list
    fp --org reliability-team sessions --since 24h
    ```

    ```bash theme={null}
    curl "https://app.befailproof.ai/v1/usage" \
      -H "Authorization: Bearer $FAILPROOFAI_KEY" \
      -H "X-AgentEye-Org: reliability-team"
    ```
  </Tab>
</Tabs>

استخدم صفحات النقطة النهائية المُنشأة في هذا القسم للحصول على المسارات والمعاملات ومتطلبات الأذونات وأكواد الحالة الحالية. يتم إنشاء المواصفات من تعليقات توجيه الخادم والتحقق منها مقابل جهاز التوجيه `/v1`.

تحتوي المواصفات الحالية على تغطية كاملة للمسار والطريقة والمعامل والإذن وأكواد الحالة. تبقى بعض أجسام الاستجابة غير مكتوبة بقصد لأن الخادم لا يزال ينشئها كـ JSON ديناميكي. افحص رد فعل حقيقي قبل إنشاء عميل مكتوب بقوة حول نقطة نهائية بدون مخطط استجابة.

استخدم `Content-Type: application/json` لعمليات كتابة JSON. تعامل مع `401` كمصادقة مفقودة أو غير صالحة، و`403` كهوية صالحة بدون الإذن المطلوب، و`404` كمورد مفقود أو غير قابل للوصول للمنظمة، و`409` كتضارب في الحالة، و`422` كقيمة حقل أو إذن غير صالحة. تتضمن استجابات الخطأ رسالة قابلة للقراءة من قبل الإنسان؛ تسمي أيضًا فشل الأذونات المنحة المطلوبة.

<Warning>
  نشر إنفاذ السياسة يتم إدارته بقصد خارج سطح `/v1` العام العادي. استخدم سير عمل نشر Cloud المدعوم.
</Warning>