תיעוד

API admin

אוטומציה של betool מהמערכות שלכם — מודלים, חשבונות LLM, חיוב, צריכה, יומני ביקורת.

ממשק הניהול (admin) של betool נשען על REST API מאומת (קידומת /api), שניתן להשתמש בו גם מהסקריפטים שלכם: dashboards מותאמים של צריכה, ייצוא יומנים, מעקב אחר יתרת הקרדיטים.

אימות

כל קריאה נושאת טוקן סשן ב-Authorization: Bearer. לשימוש אוטומטי, צרו אסימון CLI ארוך-טווח מתפריט הארגון → הגדרות הארגון → אסימוני CLI (הערך הגלוי מוצג פעם אחת בלבד, ניתן לביטול בכל עת, מגובב (hashed) בצד השרת), ואז החליפו אותו בטוקן סשן:

# 1. החלפת אסימון ה-CLI בסשן (מוגבל קצב: 10 לדקה)
curl -X POST https://platform.betool.ai/api/auth/cli-login \
  -H "Content-Type: application/json" \
  -d "{\"token\": \"$BETOOL_CLI_TOKEN\"}"
# -> {"session_token": "...", "user": {...}, "active_org": {...}, ...}

# 2. קריאה ל-API עם הסשן
curl -H "Authorization: Bearer $BETOOL_SESSION" \
  https://platform.betool.ai/api/auth/me

אסימון CLI מוצמד לארגון אחד; הוא מפסיק לפעול אם מחזיקו הושבת או אינו עוד חבר פעיל בארגון זה. ההרשאות עוקבות אחר החברות (membership) שלו.

סינון

endpoints הרשימה מקבלים פרמטרים ייחודיים לכל משאב (בדרך כלל limit התחום בצד השרת); השדות הזמינים מתועדים בתגובה עצמה.

Endpoints עיקריים

Endpointתיאור
GET /api/auth/meזהות, ארגון פעיל, חברויות
GET /api/admin/modelsרשימת המודלים (pipelines)
GET /api/admin/llm/accountsרשימת חשבונות ה-LLM (סוד מוסתר, has_api_key)
GET /api/admin/billing/stateתוכנית, יתרת קרדיטים, טעינה אוטומטית
POST /api/admin/billing/topupטעינה ידנית (קישור תשלום)
GET /api/admin/billing/usageיומן צריכה (limit ≤ 500, מסנן source_kind)
GET /api/admin/me/supervisor-readsיומן ביקורת של גישות cross-tenant

כדי לנהל את התצורה בשפה טבעית (יצירה/עריכה של pipeline באמצעות הצעות, המוחלות רק לאחר שאושרו), העדיפו את שרת ה-MCP: זהו הממשק שתוכנן ללקוחות חיצוניים.

Webhooks יוצאים

צריכים לדחוף אירועים למערכות שלכם? שלחו אותם מה-pipelines שלכם עם הצומת webhook_action — ראו Webhooks יוצאים.

Rate limiting

ה-endpoints של האימות (הרשמה, התחברות, איפוס) מוגבלי קצב. ל-endpoints האחרים אין מכסה מפורסמת נכון להיום — שימוש אוטומטי אינטנסיבי צריך להישאר סביר.

SDK

אין SDK רשמי. ה-API פשוט מספיק לצריכה מכל שפה עם client HTTP.

אם כתבתם SDK לארגון שלכם — הודיעו לנו ונפנה אליו.