תיעוד
API

Chat Completions

Markdown

תשובת המודל לשיחה בפורמט OpenAI. זהו הפורמט הנפוץ ביותר: כמעט כל הלקוחות תומכים בו.

המדריך המלא
POSThttps://api.ailoot.ai/v1/chat/completions
Chat Completions
curl https://api.ailoot.ai/v1/chat/completions \
  -H "Authorization: Bearer $AILOOT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "claude-sonnet-5-5",
    "messages": [
      {"role": "user", "content": "הסבר בשני משפטים מהו API."}
    ]
  }' 
200 OK
{
  "id": "chatcmpl-8f2c…",
  "object": "chat.completion",
  "created": 1790812800,
  "model": "claude-sonnet-5-5",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "API הוא מוסכמה לגבי הדרך שבה תוכנית אחת מבקשת מאחרת לבצע פעולה…"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 21,
    "completion_tokens": 48,
    "total_tokens": 69
  }
}

אימות

  • Authorizationheaderחובה

    המפתח בפורמט Bearer sk-…. אפשר להשתמש גם בכותרות x-api-key או x-goog-api-key.

גוף הבקשה

  • modelstringחובה

    מזהה המודל מתוך הקטלוג, לדוגמה claude-sonnet-5-5. המודל חייב לתמוך בפורמט OpenAI Chat.

  • messagesarrayחובה

    היסטוריית השיחה: אובייקטים עם role (system, developer, user, assistant, tool) וכן content — מחרוזת או מערך של חלקים (טקסט, image_url).

  • streambooleanרשות

    תשובה בפורמט Server-Sent Events. ברירת המחדל היא false. הטקסט בתשלום מגיע כבלוק אחד לאחר חישוב העלות, ולא מילה אחר מילה.

  • stream_optionsobjectרשות

    {"include_usage": true} — לשליחת הנתונים הסופיים של usage כאירוע האחרון בזרם.

  • max_tokensintegerרשות

    מספר הטוקנים המרבי בתשובה. השם החדש הוא max_completion_tokens. אם לא צוינה מגבלה, Ailoot מגדיר 4096 (או פחות, אם מגבלת התשובה של המודל נמוכה יותר; ל-Grok יש מגבלה משלו). לתשובות ארוכות יש להגדיר מגבלה במפורש, אחרת התשובה תיעצר לאחר 4096 טוקנים עם finish_reason: "length". המגבלה נכללת ברזרבה: ככל שהיא גבוהה יותר, נדרשת יותר יתרה פנויה.

  • temperaturenumberרשות

    מידת האקראיות של התשובה, בדרך כלל מ-0 עד 2. במודלי הסקה ייתכן שהפרמטר לא יובא בחשבון.

  • top_pnumberרשות

    חלופה ל-temperature: חלק ממסת ההסתברות המשמש לבחירת טוקנים.

  • stopstring | arrayרשות

    מחרוזות שבהן יצירת התשובה תיעצר.

  • toolsarrayרשות

    תיאורי פונקציות שהמודל יכול לקרוא להן. הפורמט זהה לזה של OpenAI: {"type": "function", "function": {...}}.

  • tool_choicestring | objectרשות

    auto, none, required או פונקציה מסוימת.

  • response_formatobjectרשות

    {"type": "json_object"} או {"type": "json_schema", ...} לתשובה מובנית — אם המודל תומך בכך.

  • reasoning_effortstringרשות

    עומק ההסקה במודלי הסקה: low, medium, high.

שאר הפרמטרים של OpenAI מועברים כפי שהם; מפתח המודל קובע אם המודל המסוים תומך בהם.

תשובה

  • choices[].messageobject

    תשובת המודל: content, ובקריאה לכלים — tool_calls.

  • choices[].finish_reasonstring

    stop — התשובה הסתיימה; length — הגיעה למגבלת max_tokens (גם תשובה כזו נחשבת מלאה ומחויבת לפי השימוש בפועל); tool_calls — המודל קורא לכלי.

  • usageobject

    prompt_tokens, completion_tokens, total_tokens — לפיהם מחושב החיוב.

נשארו שאלות? שלחו Request ID ותיאור — נעזור לברר.פנייה לתמיכה