Source: https://ailoot.ai/docs/he/api/chat-completions/
Canonical: https://ailoot.ai/docs/he/api/chat-completions/
Language: he

[API](https://ailoot.ai/docs/he/) 

# Chat Completions

[Markdown](https://ailoot.ai/docs/he/api/chat-completions/index.md)

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

POST`https://api.ailoot.ai/v1/chat/completions`

Chat Completions

```bash
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."}
    ]
  }' 
```

```python
from openai import OpenAI
import os

client = OpenAI(max_retries=0, 
    base_url="https://api.ailoot.ai/v1",
    api_key=os.environ["AILOOT_API_KEY"],
)

resp = client.chat.completions.create(
    model="claude-sonnet-5-5",
    messages=[{"role": "user", "content": "הסבר בשני משפטים מהו API."}],
)
print(resp.choices[0].message.content)
```

```js
import OpenAI from "openai";

const client = new OpenAI({ maxRetries: 0,
  baseURL: "https://api.ailoot.ai/v1",
  apiKey: process.env.AILOOT_API_KEY,
});

const resp = await client.chat.completions.create({
  model: "claude-sonnet-5-5",
  messages: [{ role: "user", content: "הסבר בשני משפטים מהו API." }],
});
console.log(resp.choices[0].message.content);
```

200 OK

```json
{
  "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
  }
}
```

## אימות

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

## גוף הבקשה

| פרמטר | סוג | חובה | תיאור |
| --- | --- | --- | --- |
| `model` | string | חובה | מזהה המודל מתוך [הקטלוג](https://ailoot.ai/models/he/), לדוגמה `claude-sonnet-5-5`. המודל חייב לתמוך בפורמט OpenAI Chat. |
| `messages` | array | חובה | היסטוריית השיחה: אובייקטים עם `role` (`system`, `developer`, `user`, `assistant`, `tool`) וכן `content` — מחרוזת או מערך של חלקים (טקסט, `image_url`). |
| `stream` | boolean | רשות | תשובה בפורמט Server-Sent Events. ברירת המחדל היא `false`. הטקסט בתשלום מגיע כבלוק אחד לאחר חישוב העלות, ולא מילה אחר מילה. |
| `stream_options` | object | רשות | `{"include_usage": true}` — לשליחת הנתונים הסופיים של `usage` כאירוע האחרון בזרם. |
| `max_tokens` | integer | רשות | מספר הטוקנים המרבי בתשובה. השם החדש הוא `max_completion_tokens`. אם לא צוינה מגבלה, Ailoot מגדיר 4096 (או פחות, אם מגבלת התשובה של המודל נמוכה יותר; ל-Grok יש מגבלה משלו). לתשובות ארוכות יש להגדיר מגבלה במפורש, אחרת התשובה תיעצר לאחר 4096 טוקנים עם `finish_reason: "length"`. המגבלה נכללת ברזרבה: ככל שהיא גבוהה יותר, נדרשת יותר יתרה פנויה. |
| `temperature` | number | רשות | מידת האקראיות של התשובה, בדרך כלל מ-0 עד 2. במודלי הסקה ייתכן שהפרמטר לא יובא בחשבון. |
| `top_p` | number | רשות | חלופה ל-temperature: חלק ממסת ההסתברות המשמש לבחירת טוקנים. |
| `stop` | string \| array | רשות | מחרוזות שבהן יצירת התשובה תיעצר. |
| `tools` | array | רשות | תיאורי פונקציות שהמודל יכול לקרוא להן. הפורמט זהה לזה של OpenAI: `{"type": "function", "function": {...}}`. |
| `tool_choice` | string \| object | רשות | `auto`, `none`, `required` או פונקציה מסוימת. |
| `response_format` | object | רשות | `{"type": "json_object"}` או `{"type": "json_schema", ...}` לתשובה מובנית — אם המודל תומך בכך. |
| `reasoning_effort` | string | רשות | עומק ההסקה במודלי הסקה: `low`, `medium`, `high`. |

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

## תשובה

| פרמטר | סוג | חובה | תיאור |
| --- | --- | --- | --- |
| `choices[].message` | object |  | תשובת המודל: `content`, ובקריאה לכלים — `tool_calls`. |
| `choices[].finish_reason` | string |  | `stop` — התשובה הסתיימה; `length` — הגיעה למגבלת `max_tokens` (גם תשובה כזו נחשבת מלאה ומחויבת לפי השימוש בפועל); `tool_calls` — המודל קורא לכלי. |
| `usage` | object |  | `prompt_tokens`, `completion_tokens`, `total_tokens` — לפיהם מחושב החיוב. |

נשארו שאלות? שלחו Request ID ותיאור — נעזור לברר.[פנייה לתמיכה](mailto:support@ailoot.ai)

## Ailoot · החברה ופורטפוליו הפרויקטים שלה





Ailoot נשענת על ניסיון תפעולי מצטבר, בסיס לקוחות רחב, שירות יציב ובקרה שוטפת של KPI.





החברה ופורטפוליו הפרויקטים שלה: מיליוני לקוחות; מכירות בהיקף של מיליארדים מדי חודש.





Ailoot משתמשת בניסיון התפעולי הזה כדי לספק גישת API ליכולות AI במוצרי לקוחות, בסוכנים, באפליקציות ובאוטומציות.
