Claude Platform Docs

Environment

Buat Environment
client.beta.environments.create(params, options?): BetaEnvironment
POST/v1/environments

Buat environment baru dengan konfigurasi yang ditentukan.

Daftar Environment
client.beta.environments.list(params?, options?): PageCursor<BetaEnvironment>
GET/v1/environments

Daftar environment dengan dukungan paginasi.

Dapatkan Environment
client.beta.environments.retrieve(environmentID, params?, options?): BetaEnvironment
GET/v1/environments/{environment_id}

Ambil environment tertentu berdasarkan ID.

Perbarui Environment
client.beta.environments.update(environmentID, params, options?): BetaEnvironment
POST/v1/environments/{environment_id}

Perbarui konfigurasi environment yang sudah ada.

Hapus Environment
client.beta.environments.delete(environmentID, params?, options?): BetaEnvironmentDeleteResponse
DELETE/v1/environments/{environment_id}

Hapus environment berdasarkan ID. Mengembalikan konfirmasi penghapusan.

Arsipkan Environment
client.beta.environments.archive(environmentID, params?, options?): BetaEnvironment
POST/v1/environments/{environment_id}/archive

Arsipkan environment berdasarkan ID. Environment yang diarsipkan tidak dapat digunakan untuk membuat sesi baru.

Models
interface BetaCloudConfig { type: "cloud"; networking; packages }

cloud environment configuration.

interface BetaCloudConfigParams { type: "cloud"; networking; packages }

Request params for cloud environment configuration.

Fields default to null; on update, omitted fields preserve the existing value.

interface BetaEnvironment { type: "environment"; id; archived_at; /* 7 more */ }

Unified Environment resource for both cloud and self-hosted environments.

interface BetaEnvironmentDeleteResponse { type: "environment_deleted"; id }

Response after deleting an environment.

type: "environment_deleted"

The type of response

defaultenvironment_deleted
id: string

Environment identifier

interface BetaLimitedNetwork { type: "limited"; allow_mcp_servers; allow_package_managers; allowed_hosts }

Limited network access.

type: "limited"

Network policy type

allow_mcp_servers: boolean

Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the allowed_hosts array.

allow_package_managers: boolean

Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the allowed_hosts array.

allowed_hosts: Array<string>

Specifies domains the container can reach.

interface BetaLimitedNetworkParams { type: "limited"; allow_mcp_servers; allow_package_managers; allowed_hosts }

Limited network request params.

Fields default to null; on update, omitted fields preserve the existing value.

type: "limited"

Network policy type

allow_mcp_servers?: boolean | null

Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the allowed_hosts array. Defaults to false.

allow_package_managers?: boolean | null

Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the allowed_hosts array. Defaults to false on creation. Must be true when packages are specified.

allowed_hosts?: Array<string> | null

Specifies domains the container can reach.

interface BetaPackages { type: "packages"; apt; cargo; /* 4 more */ }

Packages (and their versions) available in this environment.

type?: "packages"

Package configuration type

defaultpackages
apt: Array<string>

Ubuntu/Debian packages to install

cargo: Array<string>

Rust packages to install

gem: Array<string>

Ruby packages to install

go: Array<string>

Go packages to install

npm: Array<string>

Node.js packages to install

pip: Array<string>

Python packages to install

interface BetaPackagesParams { type: "packages"; apt; cargo; /* 4 more */ }

Specify packages (and optionally their versions) available in this environment.

When versioning, use the version semantics relevant for the package manager, e.g. for pip use package==1.0.0. You are responsible for validating the package and version exist. Unversioned installs the latest.

Under limited networking, requires networking.allow_package_managers to be true.

interface BetaSelfHostedConfig { type: "self_hosted" }

Configuration for self-hosted environments.

type: "self_hosted"

Environment type

interface BetaSelfHostedConfigParams { type: "self_hosted" }

Request params for self_hosted environment configuration.

type: "self_hosted"

Environment type

interface BetaUnrestrictedNetwork { type: "unrestricted" }

Unrestricted network access.

type: "unrestricted"

Network policy type

EnvironmentPekerjaan

Dapatkan Item Pekerjaan
client.beta.environments.work.retrieve(workID, params, options?): BetaSelfHostedWork
GET/v1/environments/{environment_id}/work/{work_id}

Catatan: endpoint ini dipanggil secara otomatis oleh environment worker siap pakai yang disediakan dalam SDK dan CLI, untuk mengorkestrasi sesi dengan environment sandbox yang di-hosting sendiri. Endpoint ini disertakan di sini sebagai referensi; Anda tidak perlu memanggilnya secara langsung.

Poll untuk Pekerjaan
client.beta.environments.work.poll(environmentID, params?, options?): BetaSelfHostedWork | null
GET/v1/environments/{environment_id}/work/poll

Catatan: endpoint ini dipanggil secara otomatis oleh environment worker siap pakai yang disediakan dalam SDK dan CLI, untuk mengorkestrasi sesi dengan environment sandbox yang di-hosting sendiri. Endpoint ini disertakan di sini sebagai referensi; Anda tidak perlu memanggilnya secara langsung.

Konfirmasi Pekerjaan
client.beta.environments.work.ack(workID, params, options?): BetaSelfHostedWork
POST/v1/environments/{environment_id}/work/{work_id}/ack

Catatan: endpoint ini dipanggil secara otomatis oleh environment worker siap pakai yang disediakan dalam SDK dan CLI, untuk mengorkestrasi sesi dengan environment sandbox yang di-hosting sendiri. Endpoint ini disertakan di sini sebagai referensi; Anda tidak perlu memanggilnya secara langsung.

Catat Heartbeat
client.beta.environments.work.heartbeat(workID, params, options?): BetaSelfHostedWorkHeartbeatResponse
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat

Catatan: endpoint ini dipanggil secara otomatis oleh environment worker siap pakai yang disediakan dalam SDK dan CLI, untuk mengorkestrasi sesi dengan environment sandbox yang di-hosting sendiri. Endpoint ini disertakan di sini sebagai referensi; Anda tidak perlu memanggilnya secara langsung.

Hentikan Pekerjaan
client.beta.environments.work.stop(workID, params, options?): BetaSelfHostedWork
POST/v1/environments/{environment_id}/work/{work_id}/stop

Catatan: endpoint ini dipanggil secara otomatis oleh environment worker siap pakai yang disediakan dalam SDK dan CLI, untuk mengorkestrasi sesi dengan environment sandbox yang di-hosting sendiri. Endpoint ini disertakan di sini sebagai referensi; Anda tidak perlu memanggilnya secara langsung.

Daftar Item Pekerjaan
client.beta.environments.work.list(environmentID, params?, options?): PageCursor<BetaSelfHostedWork>
GET/v1/environments/{environment_id}/work

Catatan: endpoint ini dipanggil secara otomatis oleh environment worker siap pakai yang disediakan dalam SDK dan CLI, untuk mengorkestrasi sesi dengan environment sandbox yang di-hosting sendiri. Endpoint ini disertakan di sini sebagai referensi; Anda tidak perlu memanggilnya secara langsung.

Perbarui Item Pekerjaan
client.beta.environments.work.update(workID, params, options?): BetaSelfHostedWork
POST/v1/environments/{environment_id}/work/{work_id}

Catatan: endpoint ini dipanggil secara otomatis oleh environment worker siap pakai yang disediakan dalam SDK dan CLI, untuk mengorkestrasi sesi dengan environment sandbox yang di-hosting sendiri. Endpoint ini disertakan di sini sebagai referensi; Anda tidak perlu memanggilnya secara langsung.

Dapatkan Statistik Antrean
client.beta.environments.work.stats(environmentID, params?, options?): BetaSelfHostedWorkQueueStats
GET/v1/environments/{environment_id}/work/stats

Dapatkan statistik tentang antrean pekerjaan untuk sebuah environment.