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

title: "HTTP API"
description: "התחבר ל-API הציבורי של Failproof AI Cloud `/v1` והשתמש בייצוא הנקודה שנוצר."
icon: "braces"
--------------

ה-API הציבורי מוגש תחת `/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="תיבת יצירת המפתח החדשה עם הגדרות הרשאות והקצאות בודדות." 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>