תיעוד
API

Gemini generateContent

Markdown

הפורמט המקורי של Google Gemini: עבור Gemini CLI, Google GenAI SDK ולקוחות REST.

המדריך המלא
POSThttps://api.ailoot.ai/v1beta/models/{model}:generateContent
Gemini generateContent
curl "https://api.ailoot.ai/v1beta/models/gemini-3.8-flash:generateContent" \
  -H "x-goog-api-key: $AILOOT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "contents": [
      {"role": "user", "parts": [{"text": "הצע שלושה שמות לבית קפה."}]}
    ]
  }' 
200 OK
{
  "candidates": [
    {
      "content": {
        "role": "model",
        "parts": [{ "text": "1. «פול ואדים» 2. «טחינת הבוקר» 3. «בית הקפה שבפינה»" }]
      },
      "finishReason": "STOP"
    }
  ],
  "usageMetadata": {
    "promptTokenCount": 9,
    "candidatesTokenCount": 27,
    "totalTokenCount": 36
  },
  "modelVersion": "gemini-3.8-flash"
}

אימות

  • x-goog-api-keyheaderחובה

    מפתח sk-…. ניתן להשתמש גם ב- Authorization: Bearer או x-api-key. לצורך תאימות ל-Google מתקבל גם ?key= בכתובת — בעדיפות הנמוכה ביותר; ?api_key= נדחה עם 400. מומלץ להשתמש בכותרת: כך המפתח אינו מופיע ביומנים.

נתיב

  • modelstringחובה

    מזהה מודל בפורמט Gemini, לדוגמה gemini-3.8-flash או gemini-3.1-pro. בסך הכול 27.

POSThttps://api.ailoot.ai/v1beta/models/{model}:streamGenerateContent?alt=sse
GEThttps://api.ailoot.ai/v1beta/models

גוף הבקשה

  • contentsarrayחובה

    הודעות עם role (user/model) וכן parts: text, inlineData/fileData, functionCall/functionResponse. ניתן לצרף רק סוגי קבצים שהמודל מקבל כקלט.

  • systemInstructionobjectרשות

    הוראת מערכת טקסטואלית: {"parts": [{"text": "…"}]}.

  • generationConfigobjectרשות

    generationConfig מקבל temperature, topP, topK, maxOutputTokens, thinkingConfig, responseMimeType (text/plain או application/json), responseSchema או responseJsonSchema (אובייקט JSON), stopSequences (מערך מחרוזות), candidateCount: 1, מספר שלם עבור seed, ערכים מספריים עבור presencePenalty וכן frequencyPenalty. הטווחים והיכולות המותרים תלויים במודל המדויק; לתשובת JSON יש לבחור צורת סכימה נתמכת אחת ואת application/json. במודלי טקסט responseModalities — רק ["TEXT"].

  • safetySettingsarrayרשות

    אובייקטים עם שדות חובה category וכן threshold, ועם שדה רשות method. הערכים חייבים להיות נתמכים במודל המדויק.

  • toolsarrayרשות

    את פונקציות הלקוח functionDeclarations מריצה האפליקציה שלכם. במודלי טקסט מתקבלים גם {"googleSearch": {}} וכן {"urlContext": {}}: בנפרד או יחד במערך tools. אי אפשר לשלב Google Search או URL context עם functionDeclarations באותה בקשה. לפלט של תמונות זמינות רק פונקציות לקוח. כלים מובנים אחרים ו-explicit cache אינם נתמכים. Search/URL context עשויים לדרוש רזרבה לפי מלוא מגבלת הקלט; הנתונים בפועל של toolUsePromptTokenCount נספרים כטוקני קלט.

  • toolConfigobjectרשות

    functionCallingConfig: mode (AUTO/ANY/NONE/VALIDATED/MODE_UNSPECIFIED), allowedFunctionNames.

אם המודל אינו תומך בשדה, בקובץ מצורף או בשילוב כלים, הבקשה נדחית לפני שמירת הרזרבה — לא מחויב דבר. תוחזר תשובת HTTP 400 עם status INVALID_ARGUMENT ובמחלקת invalid_request (בשדה ErrorInfo.reason — INVALID_REQUEST). JSON לא תקין, שגיאות בפרמטרי הנתיב ושגיאות בבדיקות אחרות מחזירים גם הם 400; יש לקרוא את הודעת השגיאה ואת ה-Request ID. היכולות תלויות במודל: בדקו את הפורמטים ואת סוגי הקלט שלו בקטלוג.

PDF, שמע, וידאו וקישורים

במודלי Gemini התומכים בסוג הקלט המתאים parts[].inlineData מכיל mimeType ונתוני base64 שאינם ריקים; קובץ PDF חייב להיות PDF אמיתי. fileData מכיל כתובת ציבורית מסוג https בשדה fileUri ואת סוג ה-MIME של הקובץ. עבור YouTube אפשר להשמיט את ה-MIME. http, כתובות פרטיות, gs:// ואובייקטים של Google Files API אינם נתמכים, וכך גם העלאה דרך Google Files API. לווידאו אפשר להוסיף videoMetadata: startOffset/endOffset כמחרוזת בשניות (לדוגמה, 1.5s) וכן fps גדול מ-0 ואינו עולה על 24. גודל גוף הבקשה, ההקשר, הקלט המותר ומגבלת התשובה נבדקים לפי המודל והפורמט.

קלטסוגי MIME נתמכים
תמונות inlineimage/png, image/jpeg, image/webp
מסמכיםapplication/pdf; text/plain, text/html, text/css, text/csv, text/xml, text/rtf, text/markdown, text/javascript, application/x-javascript, text/x-python, application/x-python
שמעaudio/wav, audio/mp3, audio/mpeg, audio/aiff, audio/aac, audio/ogg, audio/flac
וידאוvideo/mp4, video/mpeg, video/mov, video/quicktime, video/avi, video/x-flv, video/mpg, video/webm, video/wmv, video/3gpp
import json, os, urllib.request

def generate(model, payload):
    req = urllib.request.Request(
        "https://api.ailoot.ai/v1beta/models/" + model + ":generateContent",
        data=json.dumps(payload).encode(),
        headers={"x-goog-api-key": os.environ["AILOOT_API_KEY"],
                 "Content-Type": "application/json"},
    )
    # שליחה אחת. לאחר חריגה מזמן ההמתנה, בדקו את Request ID בהיסטוריית השימוש לפני ניסיון נוסף.
    with urllib.request.urlopen(req, timeout=300) as response:
        print("Request ID:", response.headers.get("X-Request-ID"))
        return json.load(response)

import base64, pathlib, sys

# ספקו קובץ PDF, שמע או וידאו מקומי אמיתי ואת סוג ה-MIME הנתמך שלו.
path, mime = pathlib.Path(sys.argv[1]), sys.argv[2]
payload = {"contents": [{"role": "user", "parts": [
    {"text": "תאר בקצרה את תוכן הקובץ."},
    {"inlineData": {"mimeType": mime,
                    "data": base64.b64encode(path.read_bytes()).decode()}},
]}]}
print(generate("gemini-3.8-flash", payload))
# קובץ מצורף חלופי: {"fileData": {"mimeType": mime, "fileUri": public_https_url}}
# עבור URL אמיתי של YouTube: {"fileData": {"fileUri": youtube_url}}

Search ו-URL context

את פונקציות הלקוח functionDeclarations מריצה האפליקציה שלכם. במודלי טקסט מתקבלים גם {"googleSearch": {}} וכן {"urlContext": {}}: בנפרד או יחד במערך tools. אי אפשר לשלב Google Search או URL context עם functionDeclarations באותה בקשה. לפלט של תמונות זמינות רק פונקציות לקוח. כלים מובנים אחרים ו-explicit cache אינם נתמכים. Search/URL context עשויים לדרוש רזרבה לפי מלוא מגבלת הקלט; הנתונים בפועל של toolUsePromptTokenCount נספרים כטוקני קלט.

{"tools": [{"googleSearch": {}}, {"urlContext": {}}]}

תמונות בפלט

בתשובה בפורמט Gemini רק המודל הבא יכול להחזיר תמונות: gemini-3.1-flash-image. זוהי יכולת נפרדת מ- /v1/images/generations: מודלי תמונות אחרים אינם פועלים כאן. מגבלת הקלט של המודל היא 131072 טוקנים ומגבלת התשובה היא 32768; מלוא העלות של התשובה הארוכה ביותר נשמרת כרזרבה מראש.

responseModalities — קבוצה לא ריקה של TEXT/IMAGE ללא כפילויות. imageConfig.imageSize: 1K/2K/4K; aspectRatio: 1:1, 2:3, 3:2, 3:4, 4:3, 4:5, 5:4, 9:16, 16:9, 21:9, 1:4, 4:1, 1:8, 8:1. הקלט למודל הוא טקסט ו-PNG/JPEG/WebP מסוג inline; PDF/audio/video/fileData והכלים המובנים Search/URL context אינם מתקבלים כאן. הזמינות והמחירים עבור המפתח שלכם מופיעים בקטלוג וב- GET /v1/models.

import json, os, urllib.request

def generate(model, payload):
    req = urllib.request.Request(
        "https://api.ailoot.ai/v1beta/models/" + model + ":generateContent",
        data=json.dumps(payload).encode(),
        headers={"x-goog-api-key": os.environ["AILOOT_API_KEY"],
                 "Content-Type": "application/json"},
    )
    # שליחה אחת. לאחר חריגה מזמן ההמתנה, בדקו את Request ID בהיסטוריית השימוש לפני ניסיון נוסף.
    with urllib.request.urlopen(req, timeout=300) as response:
        print("Request ID:", response.headers.get("X-Request-ID"))
        return json.load(response)

import base64, pathlib

reply = generate("gemini-3.1-flash-image", {
    "contents": [{"role": "user", "parts": [{"text": "צבעי מים: מגדלור עם שחר"}]}],
    "generationConfig": {
        "responseModalities": ["TEXT", "IMAGE"],
        "imageConfig": {"aspectRatio": "1:1", "imageSize": "1K"},
    },
})
index = 0
for candidate in reply.get("candidates", []):
    for part in candidate.get("content", {}).get("parts", []):
        if "text" in part:
            print(part["text"])
        blob = part.get("inlineData", {})
        if blob.get("mimeType", "").startswith("image/") and blob.get("data"):
            index += 1
            extension = {"image/png": "png", "image/jpeg": "jpg",
                         "image/webp": "webp"}.get(blob["mimeType"], "bin")
            pathlib.Path(f"gemini-image-v{index}.{extension}").write_bytes(
                base64.b64decode(blob["data"]))
print("All returned images:", index)

המחזור המלא של function calling

את הפונקציות מריץ הלקוח. יש להחזיר את כל ה-content המקורי של המודל עם thoughtSignature ללא שינוי, ולאחר מכן functionResponse עם אותו name ואותו id, אם הוא נכלל ב-functionCall.

import json, os, urllib.request

def generate(model, payload):
    req = urllib.request.Request(
        "https://api.ailoot.ai/v1beta/models/" + model + ":generateContent",
        data=json.dumps(payload).encode(),
        headers={"x-goog-api-key": os.environ["AILOOT_API_KEY"],
                 "Content-Type": "application/json"},
    )
    # שליחה אחת. לאחר חריגה מזמן ההמתנה, בדקו את Request ID בהיסטוריית השימוש לפני ניסיון נוסף.
    with urllib.request.urlopen(req, timeout=300) as response:
        print("Request ID:", response.headers.get("X-Request-ID"))
        return json.load(response)

tools = [{"functionDeclarations": [{
    "name": "multiply", "description": "להכפיל שני מספרים",
    "parameters": {"type": "object", "properties": {
        "a": {"type": "number"}, "b": {"type": "number"}},
        "required": ["a", "b"]},
}]}]
contents = [{"role": "user", "parts": [{"text": "הכפל 7 ב-8 באמצעות הפונקציה"}]}]
for turn in range(4):  # הגבילו את לולאת הכלים; אל תשלחו שוב בקשה שתוצאתה אינה ברורה.
    reply = generate("gemini-3.8-flash", {"contents": contents, "tools": tools})
    content = reply["candidates"][0]["content"]
    contents.append(content)  # השאירו את כל המקטעים המקוריים ואת thoughtSignature ללא שינוי.
    results = []
    for part in content.get("parts", []):
        call = part.get("functionCall")
        if not call:
            continue
        if call["name"] != "multiply":
            raise ValueError("Unexpected function")
        args = call["args"]
        result = {"name": call["name"], "response": {"value": args["a"] * args["b"]}}
        if "id" in call:
            result["id"] = call["id"]
        results.append({"functionResponse": result})
    if not results:
        print(content)
        break
    contents.append({"role": "user", "parts": results})
else:
    raise RuntimeError("Tool loop limit reached")

תשובה

  • candidates[].content.partsarray

    תשובת המודל.

  • usageMetadataobject

    promptTokenCount, candidatesTokenCount, totalTokenCount.

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