Gemini Environments API

הסביבות מספקות הקשרים מבודדים להרצת קוד של סוכנים, כלים ושירותים בצורה מאובטחת.

פתיחת הדף כ-Markdown פתיחת מפרט OpenAPI

CreateEnvironment

post https://generativelanguage.googleapis.com/v1beta/environments

יצירת סביבה.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

network EnvironmentNetworkEgressAllowlist or enum (string)  (optional)

הגדרת הרשת של הסביבה.

הגדרת רשת לדואר יוצא בארגז החול. מקבל אובייקט עם מערך allowlist כדי להגביל את התנועה, או את המחרוזת disabled כדי להשבית את כל הגישה לרשת. אם רוצים לאפשר את כל התנועה היוצאת בלי הוספת כותרת, משמיטים את הערך הזה לגמרי.

סוגים אפשריים

object

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

allowlist array (AllowlistEntry)  (optional)

רשימה של דומיינים שאפשר לשלוח אליהם הודעות. מותר לשלוח בקשות רק לדומיינים שמופיעים ברשימה. אפשר להשתמש ב-‎[{'domain': '*'}] ‎ כדי לאשר את כל הדומיינים, ועדיין להוסיף כותרות לדומיינים ספציפיים.

כלל אחד של רשימת היתרים לדומיין עם החדרת כותרת אופציונלית.

שדות

‫domain string  (אופציונלי)

הדומיין שאליו מותר לשלוח בקשות יוצאות. תמיכה בתווים כלליים לחיפוש (למשל '*.googleapis.com'). כדי לאשר את כל הדומיינים, צריך להשתמש בתו '*'.

transform array (object) or object  (optional)

כותרות להוספה לכל הבקשות היוצאות שתואמות לדומיין הזה. הפונקציה מקבלת מילון יחיד או רשימה של מילונים. ה-proxy של היציאה מוסיף אותם באופן אוטומטי.

מחרוזת

משבית את כל הרשת.

ערכים אפשריים

  • disabled

    משבית את כל הרשת.

sources מערך (מקור)  (אופציונלי)

מקורות שיועלו לסביבה.

מקור שיוטמע בסביבה.

שדות

content string  (אופציונלי)

התוכן בתוך השורה אם הערך של 'type' הוא 'INLINE'.

encoding string  (אופציונלי)

קידוד אופציונלי לתוכן מוטבע (למשל, base64).

source string  (אופציונלי)

המקור של הסביבה. ב-Cloud Storage, זהו הנתיב של Cloud Storage. ב-GitHub, זהו הנתיב ב-GitHub.

‫target string  (אופציונלי)

המיקום שבו המקור אמור להופיע בסביבה.

type enum (string)  (optional)

לא סופק תיאור.

ערכים אפשריים:

  • gcs

    קטגוריה של Cloud Storage.

  • inline

    תוכן מוטבע.

  • repository

    מאגר כללי. הקידומת של הפרוטוקול בכתובת ה-URL של המקור מזהה את הספק (למשל, github://‎,‏ gcs://‎).

תשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

created string  (אופציונלי)

פלט בלבד. השעה שבה הסביבה נוצרה בפורמט ISO 8601‏ (YYYY-MM-DDThh:mm:ssZ).

file_count string  (optional)

פלט בלבד. מספר הקבצים בסביבה, פלט בלבד.

id string  (אופציונלי)

חובה. פלט בלבד. המזהה של הסביבה.

last_accessed string  (optional)

פלט בלבד. השעה שבה הייתה גישה אחרונה לסביבה בפורמט ISO 8601‏ (YYYY-MM-DDThh:mm:ssZ).

network EnvironmentNetworkEgressAllowlist or enum (string)  (optional)

הגדרת הרשת של הסביבה.

הגדרת רשת לדואר יוצא בארגז החול. מקבל אובייקט עם מערך allowlist כדי להגביל את התנועה, או את המחרוזת disabled כדי להשבית את כל הגישה לרשת. אם רוצים לאפשר את כל התנועה היוצאת בלי הוספת כותרת, משמיטים את הערך הזה לגמרי.

סוגים אפשריים

object

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

allowlist array (AllowlistEntry)  (optional)

רשימה של דומיינים שאפשר לשלוח אליהם הודעות. מותר לשלוח בקשות רק לדומיינים שמופיעים ברשימה. אפשר להשתמש ב-‎[{'domain': '*'}] ‎ כדי לאשר את כל הדומיינים, ועדיין להוסיף כותרות לדומיינים ספציפיים.

כלל אחד של רשימת היתרים לדומיין עם החדרת כותרת אופציונלית.

שדות

‫domain string  (אופציונלי)

הדומיין שאליו מותר לשלוח בקשות יוצאות. תמיכה בתווים כלליים לחיפוש (למשל '*.googleapis.com'). כדי לאשר את כל הדומיינים, צריך להשתמש בתו '*'.

transform array (object) or object  (optional)

כותרות להוספה לכל הבקשות היוצאות שתואמות לדומיין הזה. הפונקציה מקבלת מילון יחיד או רשימה של מילונים. ה-proxy של היציאה מוסיף אותם באופן אוטומטי.

מחרוזת

משבית את כל הרשת.

ערכים אפשריים

  • disabled

    משבית את כל הרשת.

size_bytes string  (optional)

פלט בלבד. הגודל הכולל של קובצי הסביבה בבייטים, פלט בלבד.

sources array (Source)  (optional)

מקורות שיועלו לסביבה.

מקור שיוטמע בסביבה.

שדות

content string  (אופציונלי)

התוכן בתוך השורה אם הערך של 'type' הוא 'INLINE'.

encoding string  (אופציונלי)

קידוד אופציונלי לתוכן מוטבע (למשל, base64).

source string  (אופציונלי)

המקור של הסביבה. ב-Cloud Storage, זהו הנתיב של Cloud Storage. ב-GitHub, זהו הנתיב ב-GitHub.

‫target string  (אופציונלי)

המיקום שבו המקור אמור להופיע בסביבה.

type enum (string)  (optional)

לא סופק תיאור.

ערכים אפשריים:

  • gcs

    קטגוריה של Cloud Storage.

  • inline

    תוכן מוטבע.

  • repository

    מאגר כללי. הקידומת של הפרוטוקול בכתובת ה-URL של המקור מזהה את הספק (למשל, github://‎,‏ gcs://‎).

status enum (string)  (optional)

פלט בלבד. הסטטוס של קונטיינר הסביבה.

ערכים אפשריים:

  • active

    פלט בלבד. הסטטוס של קונטיינר הסביבה.

  • expired

    פלט בלבד. הסטטוס של קונטיינר הסביבה.

updated string  (אופציונלי)

פלט בלבד. השעה שבה הסביבה עודכנה לאחרונה בפורמט ISO 8601‏ (YYYY-MM-DDThh:mm:ssZ).

יצירת סביבה

דוגמה לתשובה

{
  "created": "2026-08-19T00:00:00Z",
  "id": "env_abc123",
  "last_accessed": "2026-08-19T00:00:00Z",
  "sources": [
    {
      "type": "inline",
      "content": "print('Hello, World!')",
      "target": "main.py"
    }
  ],
  "status": "active",
  "updated": "2026-08-19T00:00:00Z"
}

ListEnvironments

get https://generativelanguage.googleapis.com/v1beta/environments

מציג את רשימת הסביבות.

פרמטרים של נתיב או שאילתה

page_size integer  (optional)

אופציונלי. המספר המקסימלי של סביבות שיוחזרו.\nאם לא מציינים ערך, ברירת המחדל היא 50. מספר החשבונות המקסימלי הוא 1,000.

page_token string  (optional)

אופציונלי. טוקן של חלוקה לעמודים.

תשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

environments מערך (Environment)  (אופציונלי)

סביבות ששייכות לפרויקט שצוין.

next_page_token string  (optional)

טוקן של חלוקה לעמודים.

הצגת רשימת סביבות

דוגמה לתשובה

{
  "environments": [
    {
      "created": "2026-08-19T00:00:00Z",
      "id": "env_abc123",
      "last_accessed": "2026-08-19T00:00:00Z",
      "status": "active",
      "updated": "2026-08-19T00:00:00Z"
    }
  ]
}

GetEnvironmentFiles

get https://generativelanguage.googleapis.com/v1beta/environments/{environment}/files/{path}

אחזור של מטא-נתונים של קובץ או של תוכן ספרייה מתמונת מצב של סביבה. כדי להוריד את תוכן הקובץ ישירות, מעבירים את הפרמטר ‎?alt=media או משתמשים בפונקציית העזר files.download.

פרמטרים של נתיב או שאילתה

page_size integer  (optional)

אופציונלי. המספר המקסימלי של רשומות שיוחזרו בכל דף (לרישום בספרייה).

page_token string  (optional)

אופציונלי. טוקן חלוקה לדפים של רשימת הספרייה.

‫recursive boolean  (אופציונלי)

אופציונלי. אם הערך הוא True והנתיב הוא ספרייה, הפונקציה מפרטת באופן רקורסיבי את כל הקבצים.

תשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

files array (EnvironmentFile)  (אופציונלי)

אם הנתיב המבוקש הוא ספרייה, התוכן שלה מופיע כאן. אם הנתיב המבוקש הוא קובץ, התגובה מכילה רשומה אחת עם המטא-נתונים של הקובץ. אם צוין alt=media, הערך הזה ריק (התוכן מוחזר באמצעות blob).

מטא-נתונים של קובץ או ספריה בסביבה.

שדות

created string  (אופציונלי)

פלט בלבד. זמן היצירה של הקובץ או הספרייה.

mime_type string  (optional)

פלט בלבד. סוג ה-MIME של הקובץ (לדוגמה, text/python,‏ image/png). הערך ריק עבור ספריות. NOLINT

modified string  (אופציונלי)

פלט בלבד. הזמן שבו בוצעו שינויים בקובץ או בספרייה.

name string  (אופציונלי)

פלט בלבד. שם הקובץ או הספרייה (לדוגמה, main.py או src).

path string  (אופציונלי)

פלט בלבד. הנתיב היחסי המלא בסביבה (לדוגמה, workspace/src/main.py).

size_bytes string  (optional)

פלט בלבד. גודל הקובץ או הספרייה בבייטים. NOLINT

type enum (string)  (optional)

פלט בלבד. סוג הרשומה.

ערכים אפשריים:

  • file

    קובץ רגיל.

  • directory

    ספרייה.

next_page_token string  (optional)

טוקן חלוקה לדפים של רשימת הספרייה. NOLINT

הצגת רשימת קבצים בסביבה

דוגמה לתשובה

{
  "files": [
    {
      "name": "src",
      "type": "directory",
      "created": "2026-08-19T00:00:00Z",
      "modified": "2026-08-19T00:00:00Z",
      "path": "src"
    },
    {
      "name": "main.py",
      "type": "file",
      "created": "2026-08-19T00:00:00Z",
      "mime_type": "text/x-python",
      "modified": "2026-08-19T00:00:00Z",
      "path": "main.py",
      "size_bytes": "22"
    }
  ]
}

אחזור מטא-נתונים של קובץ

דוגמה לתשובה

{
  "files": [
    {
      "name": "main.py",
      "type": "file",
      "created": "2026-08-19T00:00:00Z",
      "mime_type": "text/x-python",
      "modified": "2026-08-19T00:00:00Z",
      "path": "main.py",
      "size_bytes": "22"
    }
  ]
}

הורדת תוכן הקובץ

דוגמה לתשובה

{
  "files": [
    {
      "name": "main.py",
      "type": "file",
      "mime_type": "text/x-python",
      "path": "main.py",
      "size_bytes": "22"
    }
  ]
}

GetEnvironment

get https://generativelanguage.googleapis.com/v1beta/environments/{id}

קבלת סביבה.

תשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

created string  (אופציונלי)

פלט בלבד. השעה שבה הסביבה נוצרה בפורמט ISO 8601‏ (YYYY-MM-DDThh:mm:ssZ).

file_count string  (optional)

פלט בלבד. מספר הקבצים בסביבה, פלט בלבד.

id string  (אופציונלי)

חובה. פלט בלבד. המזהה של הסביבה.

last_accessed string  (optional)

פלט בלבד. השעה שבה הייתה גישה אחרונה לסביבה בפורמט ISO 8601‏ (YYYY-MM-DDThh:mm:ssZ).

network EnvironmentNetworkEgressAllowlist or enum (string)  (optional)

הגדרת הרשת של הסביבה.

הגדרת רשת לדואר יוצא בארגז החול. מקבל אובייקט עם מערך allowlist כדי להגביל את התנועה, או את המחרוזת disabled כדי להשבית את כל הגישה לרשת. אם רוצים לאפשר את כל התנועה היוצאת בלי הוספת כותרת, משמיטים את הערך הזה לגמרי.

סוגים אפשריים

object

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

allowlist array (AllowlistEntry)  (optional)

רשימה של דומיינים שאפשר לשלוח אליהם הודעות. מותר לשלוח בקשות רק לדומיינים שמופיעים ברשימה. אפשר להשתמש ב-‎[{'domain': '*'}] ‎ כדי לאשר את כל הדומיינים, ועדיין להוסיף כותרות לדומיינים ספציפיים.

כלל אחד של רשימת היתרים לדומיין עם החדרת כותרת אופציונלית.

שדות

‫domain string  (אופציונלי)

הדומיין שאליו מותר לשלוח בקשות יוצאות. תמיכה בתווים כלליים לחיפוש (למשל '*.googleapis.com'). כדי לאשר את כל הדומיינים, צריך להשתמש בתו '*'.

transform array (object) or object  (optional)

כותרות להוספה לכל הבקשות היוצאות שתואמות לדומיין הזה. הפונקציה מקבלת מילון יחיד או רשימה של מילונים. ה-proxy של היציאה מוסיף אותם באופן אוטומטי.

מחרוזת

משבית את כל הרשת.

ערכים אפשריים

  • disabled

    משבית את כל הרשת.

size_bytes string  (optional)

פלט בלבד. הגודל הכולל של קובצי הסביבה בבייטים, פלט בלבד.

sources array (Source)  (optional)

מקורות שיועלו לסביבה.

מקור שיוטמע בסביבה.

שדות

content string  (אופציונלי)

התוכן בתוך השורה אם הערך של 'type' הוא 'INLINE'.

encoding string  (אופציונלי)

קידוד אופציונלי לתוכן מוטבע (למשל, base64).

source string  (אופציונלי)

המקור של הסביבה. ב-Cloud Storage, זהו הנתיב של Cloud Storage. ב-GitHub, זהו הנתיב ב-GitHub.

‫target string  (אופציונלי)

המיקום שבו המקור אמור להופיע בסביבה.

type enum (string)  (optional)

לא סופק תיאור.

ערכים אפשריים:

  • gcs

    קטגוריה של Cloud Storage.

  • inline

    תוכן מוטבע.

  • repository

    מאגר כללי. הקידומת של הפרוטוקול בכתובת ה-URL של המקור מזהה את הספק (למשל, github://‎,‏ gcs://‎).

status enum (string)  (optional)

פלט בלבד. הסטטוס של קונטיינר הסביבה.

ערכים אפשריים:

  • active

    פלט בלבד. הסטטוס של קונטיינר הסביבה.

  • expired

    פלט בלבד. הסטטוס של קונטיינר הסביבה.

updated string  (אופציונלי)

פלט בלבד. השעה שבה הסביבה עודכנה לאחרונה בפורמט ISO 8601‏ (YYYY-MM-DDThh:mm:ssZ).

קבלת סביבה

דוגמה לתשובה

{
  "created": "2026-08-19T00:00:00Z",
  "id": "env_abc123",
  "last_accessed": "2026-08-19T00:00:00Z",
  "sources": [
    {
      "type": "inline",
      "content": "print('Hello, World!')",
      "target": "main.py"
    }
  ],
  "status": "active",
  "updated": "2026-08-19T00:00:00Z"
}

DeleteEnvironment

delete https://generativelanguage.googleapis.com/v1beta/environments/{id}

מחיקת סביבה.

תשובה

אם הפעולה בוצעה ללא שגיאות, התגובה תהיה ריקה.

מחיקת סביבה

משאבים

סביבה

סביבת הפעלה של סוכן.

שדות

created string  (אופציונלי)

פלט בלבד. השעה שבה הסביבה נוצרה בפורמט ISO 8601‏ (YYYY-MM-DDThh:mm:ssZ).

file_count string  (optional)

פלט בלבד. מספר הקבצים בסביבה, פלט בלבד.

id string  (אופציונלי)

חובה. פלט בלבד. המזהה של הסביבה.

last_accessed string  (optional)

פלט בלבד. השעה שבה הייתה גישה אחרונה לסביבה בפורמט ISO 8601‏ (YYYY-MM-DDThh:mm:ssZ).

network EnvironmentNetworkEgressAllowlist or enum (string)  (optional)

הגדרת הרשת של הסביבה.

הגדרת רשת לדואר יוצא בארגז החול. מקבל אובייקט עם מערך allowlist כדי להגביל את התנועה, או את המחרוזת disabled כדי להשבית את כל הגישה לרשת. אם רוצים לאפשר את כל התנועה היוצאת בלי הוספת כותרת, משמיטים את הערך הזה לגמרי.

סוגים אפשריים

object

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

allowlist array (AllowlistEntry)  (optional)

רשימה של דומיינים שאפשר לשלוח אליהם הודעות. מותר לשלוח בקשות רק לדומיינים שמופיעים ברשימה. אפשר להשתמש ב-‎[{'domain': '*'}] ‎ כדי לאשר את כל הדומיינים, ועדיין להוסיף כותרות לדומיינים ספציפיים.

כלל אחד של רשימת היתרים לדומיין עם החדרת כותרת אופציונלית.

שדות

‫domain string  (אופציונלי)

הדומיין שאליו מותר לשלוח בקשות יוצאות. תמיכה בתווים כלליים לחיפוש (למשל '*.googleapis.com'). כדי לאשר את כל הדומיינים, צריך להשתמש בתו '*'.

transform array (object) or object  (optional)

כותרות להוספה לכל הבקשות היוצאות שתואמות לדומיין הזה. הפונקציה מקבלת מילון יחיד או רשימה של מילונים. ה-proxy של היציאה מוסיף אותם באופן אוטומטי.

מחרוזת

משבית את כל הרשת.

ערכים אפשריים

  • disabled

    משבית את כל הרשת.

size_bytes string  (optional)

פלט בלבד. הגודל הכולל של קובצי הסביבה בבייטים, פלט בלבד.

sources array (Source)  (optional)

מקורות שיועלו לסביבה.

מקור שיוטמע בסביבה.

שדות

content string  (אופציונלי)

התוכן בתוך השורה אם הערך של 'type' הוא 'INLINE'.

encoding string  (אופציונלי)

קידוד אופציונלי לתוכן מוטבע (למשל, base64).

source string  (אופציונלי)

המקור של הסביבה. ב-Cloud Storage, זהו הנתיב של Cloud Storage. ב-GitHub, זהו הנתיב ב-GitHub.

‫target string  (אופציונלי)

המיקום שבו המקור אמור להופיע בסביבה.

type enum (string)  (optional)

לא סופק תיאור.

ערכים אפשריים:

  • gcs

    קטגוריה של Cloud Storage.

  • inline

    תוכן מוטבע.

  • repository

    מאגר כללי. הקידומת של הפרוטוקול בכתובת ה-URL של המקור מזהה את הספק (למשל, github://‎,‏ gcs://‎).

status enum (string)  (optional)

פלט בלבד. הסטטוס של קונטיינר הסביבה.

ערכים אפשריים:

  • active

    פלט בלבד. הסטטוס של קונטיינר הסביבה.

  • expired

    פלט בלבד. הסטטוס של קונטיינר הסביבה.

updated string  (אופציונלי)

פלט בלבד. השעה שבה הסביבה עודכנה לאחרונה בפורמט ISO 8601‏ (YYYY-MM-DDThh:mm:ssZ).