Claude Platform Docs

環境

建立環境
POST/v1/environments

使用指定的設定建立新環境。

列出環境
GET/v1/environments

列出環境，支援分頁。

取得環境
GET/v1/environments/{environment_id}

依 ID 擷取特定環境。

更新環境
POST/v1/environments/{environment_id}

更新現有環境的設定。

刪除環境
DELETE/v1/environments/{environment_id}

依 ID 刪除環境。傳回刪除確認。

封存環境
POST/v1/environments/{environment_id}/archive

依 ID 封存環境。已封存的環境無法用於建立新的工作階段。

Models
BetaCloudConfig object{ type: "cloud", networking, packages }

cloud environment configuration.

BetaCloudConfigParams object{ type: "cloud", networking, packages }

Request params for cloud environment configuration.

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

BetaEnvironment object{ type: "environment", id, archived_at, 7 more }

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

BetaEnvironmentDeleteResponse object{ type: "environment_deleted", id }

Response after deleting an environment.

type: "environment_deleted"

The type of response

defaultenvironment_deleted
id: string

Environment identifier

BetaLimitedNetwork object{ 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 of string

Specifies domains the container can reach.

BetaLimitedNetworkParams object{ 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: optional boolean or 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: optional boolean or 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: optional array of string or null

Specifies domains the container can reach.

BetaPackages object{ type: "packages", apt, cargo, 4 more }

Packages (and their versions) available in this environment.

type: optional "packages"

Package configuration type

defaultpackages
apt: array of string

Ubuntu/Debian packages to install

cargo: array of string

Rust packages to install

gem: array of string

Ruby packages to install

go: array of string

Go packages to install

npm: array of string

Node.js packages to install

pip: array of string

Python packages to install

BetaPackagesParams object{ 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.

BetaSelfHostedConfig object{ type: "self_hosted" }

Configuration for self-hosted environments.

type: "self_hosted"

Environment type

BetaSelfHostedConfigParams object{ type: "self_hosted" }

Request params for self_hosted environment configuration.

type: "self_hosted"

Environment type

BetaUnrestrictedNetwork object{ type: "unrestricted" }

Unrestricted network access.

type: "unrestricted"

Network policy type

環境工作

取得工作項目
GET/v1/environments/{environment_id}/work/{work_id}

注意：這些端點會由 SDK 和 CLI 中提供的預先建置環境工作程式自動呼叫，用於協調使用自行託管沙箱環境的工作階段。此處列出僅供參考；您無需直接呼叫它們。

輪詢工作
GET/v1/environments/{environment_id}/work/poll

注意：這些端點會由 SDK 和 CLI 中提供的預先建置環境工作程式自動呼叫，用於協調使用自行託管沙箱環境的工作階段。此處列出僅供參考；您無需直接呼叫它們。

確認工作
POST/v1/environments/{environment_id}/work/{work_id}/ack

注意：這些端點會由 SDK 和 CLI 中提供的預先建置環境工作程式自動呼叫，用於協調使用自行託管沙箱環境的工作階段。此處列出僅供參考；您無需直接呼叫它們。

記錄心跳
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat

注意：這些端點會由 SDK 和 CLI 中提供的預先建置環境工作程式自動呼叫，用於協調使用自行託管沙箱環境的工作階段。此處列出僅供參考；您無需直接呼叫它們。

停止工作
POST/v1/environments/{environment_id}/work/{work_id}/stop

注意：這些端點會由 SDK 和 CLI 中提供的預先建置環境工作程式自動呼叫，用於協調使用自行託管沙箱環境的工作階段。此處列出僅供參考；您無需直接呼叫它們。

列出工作項目
GET/v1/environments/{environment_id}/work

注意：這些端點會由 SDK 和 CLI 中提供的預先建置環境工作程式自動呼叫，用於協調使用自行託管沙箱環境的工作階段。此處列出僅供參考；您無需直接呼叫它們。

更新工作項目
POST/v1/environments/{environment_id}/work/{work_id}

注意：這些端點會由 SDK 和 CLI 中提供的預先建置環境工作程式自動呼叫，用於協調使用自行託管沙箱環境的工作階段。此處列出僅供參考；您無需直接呼叫它們。

取得佇列統計資料
GET/v1/environments/{environment_id}/work/stats

取得環境工作佇列的統計資料。