Claude Platform Docs

环境

创建环境
BetaEnvironment Beta.Environments.Create(parameters, cancellationToken = default)
POST/v1/environments

使用指定配置创建新环境。

列出环境
EnvironmentListPage Beta.Environments.List(parameters, cancellationToken = default)
GET/v1/environments

列出环境，支持分页。

获取环境
BetaEnvironment Beta.Environments.Retrieve(parameters, cancellationToken = default)
GET/v1/environments/{environment_id}

按 ID 检索特定环境。

更新环境
BetaEnvironment Beta.Environments.Update(parameters, cancellationToken = default)
POST/v1/environments/{environment_id}

更新现有环境的配置。

删除环境
BetaEnvironmentDeleteResponse Beta.Environments.Delete(parameters, cancellationToken = default)
DELETE/v1/environments/{environment_id}

按 ID 删除环境。返回删除确认。

归档环境
BetaEnvironment Beta.Environments.Archive(parameters, cancellationToken = default)
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.

required Type Type

The type of response

required string ID

Environment identifier

class BetaLimitedNetwork { Type = "limited"; AllowMcpServers; AllowPackageManagers; AllowedHosts; }

Limited network access.

JsonElement Type = "limited"

Network policy type

required bool AllowMcpServers

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

required bool AllowPackageManagers

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

required IReadOnlyList<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.

JsonElement Type = "limited"

Network policy type

bool? AllowMcpServers

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

bool? 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.

IReadOnlyList<string>? AllowedHosts

Specifies domains the container can reach.

class BetaPackages { Type; Apt; Cargo; /* 4 more */ }

Packages (and their versions) available in this environment.

Type Type

Package configuration type

required IReadOnlyList<string> Apt

Ubuntu/Debian packages to install

required IReadOnlyList<string> Cargo

Rust packages to install

required IReadOnlyList<string> Gem

Ruby packages to install

required IReadOnlyList<string> Go

Go packages to install

required IReadOnlyList<string> Npm

Node.js packages to install

required IReadOnlyList<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.

Type Type

Package configuration type

IReadOnlyList<string>? Apt

Ubuntu/Debian packages to install

IReadOnlyList<string>? Cargo

Rust packages to install

IReadOnlyList<string>? Gem

Ruby packages to install

IReadOnlyList<string>? Go

Go packages to install

IReadOnlyList<string>? Npm

Node.js packages to install

IReadOnlyList<string>? Pip

Python packages to install

class BetaSelfHostedConfig { Type = "self_hosted"; }

Configuration for self-hosted environments.

JsonElement Type = "self_hosted"

Environment type

class BetaSelfHostedConfigParams { Type = "self_hosted"; }

Request params for self_hosted environment configuration.

JsonElement Type = "self_hosted"

Environment type

class BetaUnrestrictedNetwork { Type = "unrestricted"; }

Unrestricted network access.

JsonElement Type = "unrestricted"

Network policy type

环境工作

获取工作项
BetaSelfHostedWork Beta.Environments.Work.Retrieve(parameters, cancellationToken = default)
GET/v1/environments/{environment_id}/work/{work_id}

注意：这些端点由 SDK 和 CLI 中提供的预构建环境工作器自动调用，用于编排使用自托管沙箱环境的会话。此处列出仅供参考；您无需直接调用它们。

轮询工作
BetaSelfHostedWork? Beta.Environments.Work.Poll(parameters, cancellationToken = default)
GET/v1/environments/{environment_id}/work/poll

注意：这些端点由 SDK 和 CLI 中提供的预构建环境工作器自动调用，用于编排使用自托管沙箱环境的会话。此处列出仅供参考；您无需直接调用它们。

确认工作
BetaSelfHostedWork Beta.Environments.Work.Ack(parameters, cancellationToken = default)
POST/v1/environments/{environment_id}/work/{work_id}/ack

注意：这些端点由 SDK 和 CLI 中提供的预构建环境工作器自动调用，用于编排使用自托管沙箱环境的会话。此处列出仅供参考；您无需直接调用它们。

记录心跳
BetaSelfHostedWorkHeartbeatResponse Beta.Environments.Work.Heartbeat(parameters, cancellationToken = default)
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat

注意：这些端点由 SDK 和 CLI 中提供的预构建环境工作器自动调用，用于编排使用自托管沙箱环境的会话。此处列出仅供参考；您无需直接调用它们。

停止工作
BetaSelfHostedWork Beta.Environments.Work.Stop(parameters, cancellationToken = default)
POST/v1/environments/{environment_id}/work/{work_id}/stop

注意：这些端点由 SDK 和 CLI 中提供的预构建环境工作器自动调用，用于编排使用自托管沙箱环境的会话。此处列出仅供参考；您无需直接调用它们。

列出工作项
WorkListPage Beta.Environments.Work.List(parameters, cancellationToken = default)
GET/v1/environments/{environment_id}/work

注意：这些端点由 SDK 和 CLI 中提供的预构建环境工作器自动调用，用于编排使用自托管沙箱环境的会话。此处列出仅供参考；您无需直接调用它们。

更新工作项
BetaSelfHostedWork Beta.Environments.Work.Update(parameters, cancellationToken = default)
POST/v1/environments/{environment_id}/work/{work_id}

注意：这些端点由 SDK 和 CLI 中提供的预构建环境工作器自动调用，用于编排使用自托管沙箱环境的会话。此处列出仅供参考；您无需直接调用它们。

获取队列统计信息
BetaSelfHostedWorkQueueStats Beta.Environments.Work.Stats(parameters, cancellationToken = default)
GET/v1/environments/{environment_id}/work/stats

获取某个环境的工作队列统计信息。