חומר עזר ל-REST API

תיעוד אינטראקטיבי

כל אפליקציית Agent-Lab מגישה OpenAPI 3 באופן אוטומטי — מימוש הדוגמה בכתובת http://localhost:18000/docs (או האפליקציה שלך, בכל מקום שבו היא רצה). הקטלוג שלהלן מתעד את הנתבים המובנים של הפריימוורק; ה-extra_routers שלך מופיעים באותה סכמה.

אימות

כאשר auth.enabled הוא true (ראו את חומר העזר לתצורה), הנתיבים דורשים bearer token של Keycloak. הנתב /auth מעוגן רק כשהאימות מופעל:

TOKEN=$(curl -s -X POST https://<host>/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username": "…", "password": "…"}' | jq -r '.access_token')

curl -s https://<host>/agents/list -H "Authorization: Bearer $TOKEN" | jq

הגדרת ה-realm/הלקוח מוסברת באימות עם Keycloak.

נתיבים ללא אימות: /status/*, /docs, /openapi.json, /mcp, /static, נקודות הקצה well-known של OAuth ונקודת העיגון של ה-SPA — כל השאר דורש טוקן תקף.

נקודות קצה

סוכנים

יוצרים מופעים של כל סוג סוכן רשום; agent_type מאומת באופן דינמי מול הרישום.

הודעות

מודלי שפה

אינטגרציות

קבצים מצורפים

סטטוס ו-MCP

דוגמאות לבקשות

יצירת מופע סוכן — agent_name מקבל [a-zA-Z0-9_-]; agent_type חייב להיות סוג רשום; language_model_id הוא אופציונלי:

curl -s -X POST http://localhost:18000/agents/create \
  -H "Content-Type: application/json" \
  -d '{
        "agent_name": "support-agent-1",
        "agent_type": "coordinator_planner_supervisor",
        "language_model_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }' | jq

שליחת הודעה — message_role הוא אחד מהערכים human, assistant, tool; attachment_id הוא אופציונלי:

curl -s -X POST http://localhost:18000/messages/post \
  -H "Content-Type: application/json" \
  -d '{
        "agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "message_role": "human",
        "message_content": "Summarize the attached report.",
        "attachment_id": null
      }' | jq

עדכון הגדרת סוכן — setting_key מקבל [a-zA-Z_-]; setting_value מכיל עד 16,000 תווים (תבניות פרומפט ומטעני JSON נשמרים כאן — ראו את מודל הדומיין של הישויות):

curl -s -X POST http://localhost:18000/agents/update_setting \
  -H "Content-Type: application/json" \
  -d '{
        "agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "setting_key": "system_prompt",
        "setting_value": "You are a concise research assistant…"
      }' | jq

מוסכמות

• מזהים הם UUIDs; כל נקודות הקצה של רשימות מקבלות גוף JSON, ולא query strings.
• הגדרות הן זוגות מפתח-ערך שנשמרים עם הסוכן או המודל — כך אותו מימוש מריץ מופעים רבים בתצורות שונות.
• הרישום הוא מקור האמת לערכי agent_type תקפים — מריצים GET /agents/types כדי לראות מה האפליקציה הפועלת גילתה (כולל החבילות שלך דרך scan_packages).