Gemini Environments API | Gemini API | Google AI for Developers

CreateEnvironment

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

สร้างสภาพแวดล้อม

เนื้อความของคำขอ
การตอบกลับ

เนื้อความของคำขอ

เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

network EnvironmentNetworkEgressAllowlist หรือ enum (สตริง) (ไม่บังคับ)

การกำหนดค่าเครือข่ายสำหรับสภาพแวดล้อม

ประเภทที่เป็นไปได้

object

การกำหนดค่าเครือข่ายขาออกสำหรับแซนด์บ็อกซ์ เมื่อระบุแล้ว จะจำกัดโดเมนภายนอกที่แซนด์บ็อกซ์เข้าถึงได้ ละเว้นทั้งหมดเพื่ออนุญาตการรับส่งข้อมูลขาออกทั้งหมดโดยไม่มีการแทรกส่วนหัว

allowlist array (AllowlistEntry) (ไม่บังคับ)

รายการโดเมนขาออกที่อนุญาต ระบบจะอนุญาตเฉพาะคำขอไปยังโดเมนที่ระบุไว้เท่านั้น ใช้ [{'domain': '*'}] เพื่ออนุญาตทุกโดเมนในขณะที่ยังคงแทรกส่วนหัวในโดเมนที่เฉพาะเจาะจง

ช่อง

โดเมน สตริง (ไม่บังคับ)

โดเมนที่จะอนุญาตคำขอขาออก รองรับไวลด์การ์ด (เช่น "*.googleapis.com") ใช้ "*" เพื่ออนุญาตทุกโดเมน

transform array (object) or object (ไม่บังคับ)

ส่วนหัวที่จะแทรกในคำขอขาออกทั้งหมดที่ตรงกับโดเมนนี้ ยอมรับพจนานุกรมรายการเดียวหรือรายการพจนานุกรม พร็อกซีขาออกจะแทรกข้อมูลเหล่านี้โดยอัตโนมัติ

สตริง

ปิดเครือข่ายทั้งหมด

ค่าที่เป็นไปได้

disabled
ปิดเครือข่ายทั้งหมด

แหล่งข้อมูล อาร์เรย์ (แหล่งข้อมูล) (ไม่บังคับ)

แหล่งข้อมูลที่จะติดตั้งในสภาพแวดล้อม

ช่อง

content string (ไม่บังคับ)

เนื้อหาในบรรทัดหาก `type` เป็น `INLINE`

การเข้ารหัส สตริง (ไม่บังคับ)

การเข้ารหัสที่ไม่บังคับสำหรับเนื้อหาในบรรทัด (เช่น `base64`)

แหล่งที่มา สตริง (ไม่บังคับ)

แหล่งที่มาของสภาพแวดล้อม สำหรับ Cloud Storage นี่คือเส้นทาง Cloud Storage สำหรับ GitHub นี่คือเส้นทาง GitHub

เป้าหมาย สตริง (ไม่บังคับ)

ตำแหน่งที่แหล่งที่มาควรปรากฏในสภาพแวดล้อม

ประเภท enum (สตริง) (ไม่บังคับ)

ไม่มีคำอธิบาย

ค่าที่เป็นไปได้ มีดังนี้

gcs
Bucket ของ Cloud Storage
inline
เนื้อหาในบรรทัด
repository
ที่เก็บทั่วไป คำนำหน้าโปรโตคอลใน URL ต้นทาง ระบุผู้ให้บริการ (เช่น github://, gcs://)

คำตอบ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

created string (ไม่บังคับ)

เอาต์พุตเท่านั้น เวลาที่สร้างสภาพแวดล้อมในรูปแบบ ISO 8601 (YYYY-MM-DDThh:mm:ssZ)

file_count string (ไม่บังคับ)

เอาต์พุตเท่านั้น จำนวนไฟล์ในสภาพแวดล้อม เอาต์พุตเท่านั้น

id string (ไม่บังคับ)

ต้องระบุ เอาต์พุตเท่านั้น รหัสของสภาพแวดล้อม

last_accessed string (ไม่บังคับ)

เอาต์พุตเท่านั้น เวลาที่เข้าถึงสภาพแวดล้อมครั้งล่าสุดในรูปแบบ ISO 8601 (YYYY-MM-DDThh:mm:ssZ)

network EnvironmentNetworkEgressAllowlist หรือ enum (สตริง) (ไม่บังคับ)

การกำหนดค่าเครือข่ายสำหรับสภาพแวดล้อม

ประเภทที่เป็นไปได้

object

การกำหนดค่าเครือข่ายขาออกสำหรับแซนด์บ็อกซ์ เมื่อระบุแล้ว จะจำกัดโดเมนภายนอกที่แซนด์บ็อกซ์เข้าถึงได้ ละเว้นทั้งหมดเพื่ออนุญาตการรับส่งข้อมูลขาออกทั้งหมดโดยไม่มีการแทรกส่วนหัว

allowlist array (AllowlistEntry) (ไม่บังคับ)

รายการโดเมนขาออกที่อนุญาต ระบบจะอนุญาตเฉพาะคำขอไปยังโดเมนที่ระบุไว้เท่านั้น ใช้ [{'domain': '*'}] เพื่ออนุญาตทุกโดเมนในขณะที่ยังคงแทรกส่วนหัวในโดเมนที่เฉพาะเจาะจง

ช่อง

โดเมน สตริง (ไม่บังคับ)

โดเมนที่จะอนุญาตคำขอขาออก รองรับไวลด์การ์ด (เช่น "*.googleapis.com") ใช้ "*" เพื่ออนุญาตทุกโดเมน

transform array (object) or object (ไม่บังคับ)

ส่วนหัวที่จะแทรกในคำขอขาออกทั้งหมดที่ตรงกับโดเมนนี้ ยอมรับพจนานุกรมรายการเดียวหรือรายการพจนานุกรม พร็อกซีขาออกจะแทรกข้อมูลเหล่านี้โดยอัตโนมัติ

สตริง

ปิดเครือข่ายทั้งหมด

ค่าที่เป็นไปได้

disabled
ปิดเครือข่ายทั้งหมด

size_bytes string (ไม่บังคับ)

เอาต์พุตเท่านั้น ขนาดรวมของไฟล์สภาพแวดล้อมในหน่วยไบต์ เอาต์พุตเท่านั้น

แหล่งที่มา อาร์เรย์ (แหล่งที่มา) (ไม่บังคับ)

แหล่งข้อมูลที่จะติดตั้งในสภาพแวดล้อม

ช่อง

content string (ไม่บังคับ)

เนื้อหาในบรรทัดหาก `type` เป็น `INLINE`

การเข้ารหัส สตริง (ไม่บังคับ)

การเข้ารหัสที่ไม่บังคับสำหรับเนื้อหาในบรรทัด (เช่น `base64`)

แหล่งที่มา สตริง (ไม่บังคับ)

แหล่งที่มาของสภาพแวดล้อม สำหรับ Cloud Storage นี่คือเส้นทาง Cloud Storage สำหรับ GitHub นี่คือเส้นทาง GitHub

เป้าหมาย สตริง (ไม่บังคับ)

ตำแหน่งที่แหล่งที่มาควรปรากฏในสภาพแวดล้อม

ประเภท enum (สตริง) (ไม่บังคับ)

ไม่มีคำอธิบาย

ค่าที่เป็นไปได้ มีดังนี้

gcs
Bucket ของ Cloud Storage
inline
เนื้อหาในบรรทัด
repository
ที่เก็บทั่วไป คำนำหน้าโปรโตคอลใน URL ต้นทาง ระบุผู้ให้บริการ (เช่น github://, gcs://)

status enum (string) (ไม่บังคับ)

เอาต์พุตเท่านั้น สถานะของคอนเทนเนอร์สภาพแวดล้อม

ค่าที่เป็นไปได้ มีดังนี้

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 (ไม่บังคับ)

ไม่บังคับ จำนวนสภาพแวดล้อมสูงสุดที่จะแสดง\nหากไม่ได้ระบุ ค่าเริ่มต้นจะเป็น 50 โดยจำนวนสูงสุดคือ 1,000 รายการ

page_token string (ไม่บังคับ)

ไม่บังคับ โทเค็นการแบ่งหน้า

คำตอบ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

environments อาร์เรย์ (Environment) (ไม่บังคับ)

สภาพแวดล้อมที่เป็นของโปรเจ็กต์ที่ระบุ

next_page_token string (ไม่บังคับ)

โทเค็นการแบ่งหน้า

แสดงรายการสภาพแวดล้อม

ตัวอย่างการตอบกลับ

{
  "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 (ไม่บังคับ)

ไม่บังคับ จำนวนรายการสูงสุดที่จะแสดงต่อหน้า (สำหรับข้อมูลไดเรกทอรี)

page_token string (ไม่บังคับ)

ไม่บังคับ โทเค็นการแบ่งหน้าสำหรับข้อมูลไดเรกทอรี

recursive boolean (ไม่บังคับ)

ไม่บังคับ หากเป็นจริงและเส้นทางเป็นไดเรกทอรี จะแสดงรายการไฟล์ทั้งหมดแบบเรียกซ้ำ

คำตอบ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

files array (EnvironmentFile) (ไม่บังคับ)

หากเส้นทางที่ขอเป็นไดเรกทอรี ข้อมูลนี้จะมีเนื้อหาของไดเรกทอรี หากเส้นทางที่ขอเป็นไฟล์ จะมีรายการเดียวที่มีข้อมูลเมตาของไฟล์ หากมีการระบุ alt=media ค่านี้จะว่างเปล่า (ระบบจะแสดงเนื้อหาผ่าน `blob`)

ช่อง

created string (ไม่บังคับ)

เอาต์พุตเท่านั้น เวลาที่สร้างไฟล์/ไดเรกทอรี

mime_type string (ไม่บังคับ)

เอาต์พุตเท่านั้น ประเภท MIME ของไฟล์ (เช่น "text/python", "image/png") เว้นว่างไว้สำหรับไดเรกทอรี NOLINT

modified string (ไม่บังคับ)

เอาต์พุตเท่านั้น เวลาแก้ไขของไฟล์/ไดเรกทอรี

name string (ไม่บังคับ)

เอาต์พุตเท่านั้น ชื่อของไฟล์หรือไดเรกทอรี (เช่น "main.py" หรือ "src")

เส้นทาง สตริง (ไม่บังคับ)

เอาต์พุตเท่านั้น เส้นทางแบบสัมบูรณ์แบบเต็มภายในสภาพแวดล้อม (เช่น "workspace/src/main.py")

size_bytes string (ไม่บังคับ)

เอาต์พุตเท่านั้น ขนาดของไฟล์/ไดเรกทอรีในหน่วยไบต์ NOLINT

ประเภท enum (สตริง) (ไม่บังคับ)

เอาต์พุตเท่านั้น ประเภทของรายการ

ค่าที่เป็นไปได้ มีดังนี้

file
ไฟล์ปกติ
directory
ไดเรกทอรี

next_page_token string (ไม่บังคับ)

โทเค็นการแบ่งหน้าสำหรับการแสดงข้อมูลไดเรกทอรี 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 (ไม่บังคับ)

เอาต์พุตเท่านั้น จำนวนไฟล์ในสภาพแวดล้อม เอาต์พุตเท่านั้น

id string (ไม่บังคับ)

ต้องระบุ เอาต์พุตเท่านั้น รหัสของสภาพแวดล้อม

last_accessed string (ไม่บังคับ)

เอาต์พุตเท่านั้น เวลาที่เข้าถึงสภาพแวดล้อมครั้งล่าสุดในรูปแบบ ISO 8601 (YYYY-MM-DDThh:mm:ssZ)

network EnvironmentNetworkEgressAllowlist หรือ enum (สตริง) (ไม่บังคับ)

การกำหนดค่าเครือข่ายสำหรับสภาพแวดล้อม

ประเภทที่เป็นไปได้

object

การกำหนดค่าเครือข่ายขาออกสำหรับแซนด์บ็อกซ์ เมื่อระบุแล้ว จะจำกัดโดเมนภายนอกที่แซนด์บ็อกซ์เข้าถึงได้ ละเว้นทั้งหมดเพื่ออนุญาตการรับส่งข้อมูลขาออกทั้งหมดโดยไม่มีการแทรกส่วนหัว

allowlist array (AllowlistEntry) (ไม่บังคับ)

รายการโดเมนขาออกที่อนุญาต ระบบจะอนุญาตเฉพาะคำขอไปยังโดเมนที่ระบุไว้เท่านั้น ใช้ [{'domain': '*'}] เพื่ออนุญาตทุกโดเมนในขณะที่ยังคงแทรกส่วนหัวในโดเมนที่เฉพาะเจาะจง

ช่อง

โดเมน สตริง (ไม่บังคับ)

โดเมนที่จะอนุญาตคำขอขาออก รองรับไวลด์การ์ด (เช่น "*.googleapis.com") ใช้ "*" เพื่ออนุญาตทุกโดเมน

transform array (object) or object (ไม่บังคับ)

ส่วนหัวที่จะแทรกในคำขอขาออกทั้งหมดที่ตรงกับโดเมนนี้ ยอมรับพจนานุกรมรายการเดียวหรือรายการพจนานุกรม พร็อกซีขาออกจะแทรกข้อมูลเหล่านี้โดยอัตโนมัติ

สตริง

ปิดเครือข่ายทั้งหมด

ค่าที่เป็นไปได้

disabled
ปิดเครือข่ายทั้งหมด

size_bytes string (ไม่บังคับ)

เอาต์พุตเท่านั้น ขนาดรวมของไฟล์สภาพแวดล้อมในหน่วยไบต์ เอาต์พุตเท่านั้น

แหล่งที่มา อาร์เรย์ (แหล่งที่มา) (ไม่บังคับ)

แหล่งข้อมูลที่จะติดตั้งในสภาพแวดล้อม

ช่อง

content string (ไม่บังคับ)

เนื้อหาในบรรทัดหาก `type` เป็น `INLINE`

การเข้ารหัส สตริง (ไม่บังคับ)

การเข้ารหัสที่ไม่บังคับสำหรับเนื้อหาในบรรทัด (เช่น `base64`)

แหล่งที่มา สตริง (ไม่บังคับ)

แหล่งที่มาของสภาพแวดล้อม สำหรับ Cloud Storage นี่คือเส้นทาง Cloud Storage สำหรับ GitHub นี่คือเส้นทาง GitHub

เป้าหมาย สตริง (ไม่บังคับ)

ตำแหน่งที่แหล่งที่มาควรปรากฏในสภาพแวดล้อม

ประเภท enum (สตริง) (ไม่บังคับ)

ไม่มีคำอธิบาย

ค่าที่เป็นไปได้ มีดังนี้

gcs
Bucket ของ Cloud Storage
inline
เนื้อหาในบรรทัด
repository
ที่เก็บทั่วไป คำนำหน้าโปรโตคอลใน URL ต้นทาง ระบุผู้ให้บริการ (เช่น github://, gcs://)

status enum (string) (ไม่บังคับ)

เอาต์พุตเท่านั้น สถานะของคอนเทนเนอร์สภาพแวดล้อม

ค่าที่เป็นไปได้ มีดังนี้

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}

ลบสภาพแวดล้อม

การตอบกลับ

คำตอบ

หากทำสำเร็จ การตอบกลับจะว่างเปล่า