Claude Platform Docs

環境

建立環境
BetaEnvironment beta().environments().create(params, requestOptions = RequestOptions.none())
POST/v1/environments

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

列出環境
EnvironmentListPage beta().environments().list(params = EnvironmentListParams.none(), requestOptions = RequestOptions.none())
GET/v1/environments

列出環境，支援分頁。

取得環境
BetaEnvironment beta().environments().retrieve(params = EnvironmentRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/environments/{environment_id}

依 ID 擷取特定環境。

更新環境
BetaEnvironment beta().environments().update(params = EnvironmentUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/environments/{environment_id}

更新現有環境的設定。

刪除環境
BetaEnvironmentDeleteResponse beta().environments().delete(params = EnvironmentDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/environments/{environment_id}

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

封存環境
BetaEnvironment beta().environments().archive(params = EnvironmentArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/environments/{environment_id}/archive

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

Models
class BetaCloudConfig { type = "cloud"; networking; packages; }

cloud environment configuration.

class BetaCloudConfigParams { type = "cloud"; networking; packages; }

Request params for cloud environment configuration.

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

class BetaEnvironment { type = "environment"; id; archivedAt; /* 7 more */ }

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

class BetaEnvironmentDeleteResponse { type; id; }

Response after deleting an environment.

Type type

The type of response

String id

Environment identifier

class BetaLimitedNetwork { type = "limited"; allowMcpServers; allowPackageManagers; allowedHosts; }

Limited network access.

JsonValue type = "limited"

Network policy type

boolean allowMcpServers

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

boolean allowPackageManagers

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

List<String> allowedHosts

Specifies domains the container can reach.

class BetaLimitedNetworkParams { type = "limited"; allowMcpServers; allowPackageManagers; allowedHosts; }

Limited network request params.

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

JsonValue type = "limited"

Network policy type

Optional<Boolean> allowMcpServers

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

Optional<Boolean> allowPackageManagers

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.

Optional<List<String>> allowedHosts

Specifies domains the container can reach.

class BetaPackages { type; apt; cargo; /* 4 more */ }

Packages (and their versions) available in this environment.

Optional<Type> type

Package configuration type

List<String> apt

Ubuntu/Debian packages to install

List<String> cargo

Rust packages to install

List<String> gem

Ruby packages to install

List<String> go

Go packages to install

List<String> npm

Node.js packages to install

List<String> pip

Python packages to install

class BetaPackagesParams { type; 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.

Optional<Type> type

Package configuration type

Optional<List<String>> apt

Ubuntu/Debian packages to install

Optional<List<String>> cargo

Rust packages to install

Optional<List<String>> gem

Ruby packages to install

Optional<List<String>> go

Go packages to install

Optional<List<String>> npm

Node.js packages to install

Optional<List<String>> pip

Python packages to install

class BetaSelfHostedConfig { type = "self_hosted"; }

Configuration for self-hosted environments.

JsonValue type = "self_hosted"

Environment type

class BetaSelfHostedConfigParams { type = "self_hosted"; }

Request params for self_hosted environment configuration.

JsonValue type = "self_hosted"

Environment type

class BetaUnrestrictedNetwork { type = "unrestricted"; }

Unrestricted network access.

JsonValue type = "unrestricted"

Network policy type

環境工作

取得工作項目
BetaSelfHostedWork beta().environments().work().retrieve(params, requestOptions = RequestOptions.none())
GET/v1/environments/{environment_id}/work/{work_id}

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

輪詢工作
BetaSelfHostedWork beta().environments().work().poll(params = WorkPollParams.none(), requestOptions = RequestOptions.none())
GET/v1/environments/{environment_id}/work/poll

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

確認工作
BetaSelfHostedWork beta().environments().work().ack(params, requestOptions = RequestOptions.none())
POST/v1/environments/{environment_id}/work/{work_id}/ack

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

記錄心跳
BetaSelfHostedWorkHeartbeatResponse beta().environments().work().heartbeat(params, requestOptions = RequestOptions.none())
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat

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

停止工作
BetaSelfHostedWork beta().environments().work().stop(params, requestOptions = RequestOptions.none())
POST/v1/environments/{environment_id}/work/{work_id}/stop

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

列出工作項目
WorkListPage beta().environments().work().list(params = WorkListParams.none(), requestOptions = RequestOptions.none())
GET/v1/environments/{environment_id}/work

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

更新工作項目
BetaSelfHostedWork beta().environments().work().update(params, requestOptions = RequestOptions.none())
POST/v1/environments/{environment_id}/work/{work_id}

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

取得佇列統計資料
BetaSelfHostedWorkQueueStats beta().environments().work().stats(params = WorkStatsParams.none(), requestOptions = RequestOptions.none())
GET/v1/environments/{environment_id}/work/stats

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