Claude Platform Docs

环境

创建环境
beta.environments.create(**kwargs) -> BetaEnvironment
POST/v1/environments

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

列出环境
beta.environments.list(**kwargs) -> SyncPageCursor[BetaEnvironment]
GET/v1/environments

列出环境，支持分页。

获取环境
beta.environments.retrieve(environment_id, **kwargs) -> BetaEnvironment
GET/v1/environments/{environment_id}

按 ID 检索特定环境。

更新环境
beta.environments.update(environment_id, **kwargs) -> BetaEnvironment
POST/v1/environments/{environment_id}

更新现有环境的配置。

删除环境
beta.environments.delete(environment_id, **kwargs) -> BetaEnvironmentDeleteResponse
DELETE/v1/environments/{environment_id}

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

归档环境
beta.environments.archive(environment_id, **kwargs) -> BetaEnvironment
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; archived_at; ... # 7 more

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

class BetaEnvironmentDeleteResponse: type: "environment_deleted"; id

Response after deleting an environment.

type: Literal["environment_deleted"]

The type of response

defaultenvironment_deleted
id: str

Environment identifier

class BetaLimitedNetwork: type: "limited"; allow_mcp_servers; allow_package_managers; allowed_hosts

Limited network access.

type: Literal["limited"]

Network policy type

allow_mcp_servers: bool

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

allow_package_managers: bool

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

allowed_hosts: List[str]

Specifies domains the container can reach.

class 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: Literal["limited"]

Network policy type

allow_mcp_servers: Optional[bool]

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[bool]

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[List[str]]

Specifies domains the container can reach.

class BetaPackages: type; apt; cargo; ... # 4 more

Packages (and their versions) available in this environment.

type: Optional[Literal["packages"]]

Package configuration type

defaultpackages
apt: List[str]

Ubuntu/Debian packages to install

cargo: List[str]

Rust packages to install

gem: List[str]

Ruby packages to install

go: List[str]

Go packages to install

npm: List[str]

Node.js packages to install

pip: List[str]

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.

class BetaSelfHostedConfig: type: "self_hosted"

Configuration for self-hosted environments.

type: Literal["self_hosted"]

Environment type

class BetaSelfHostedConfigParams: type: "self_hosted"

Request params for self_hosted environment configuration.

type: Literal["self_hosted"]

Environment type

class BetaUnrestrictedNetwork: type: "unrestricted"

Unrestricted network access.

type: Literal["unrestricted"]

Network policy type

环境工作

获取工作项
beta.environments.work.retrieve(work_id, **kwargs) -> BetaSelfHostedWork
GET/v1/environments/{environment_id}/work/{work_id}

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

轮询工作
beta.environments.work.poll(environment_id, **kwargs) -> BetaSelfHostedWork
GET/v1/environments/{environment_id}/work/poll

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

确认工作
beta.environments.work.ack(work_id, **kwargs) -> BetaSelfHostedWork
POST/v1/environments/{environment_id}/work/{work_id}/ack

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

记录心跳
beta.environments.work.heartbeat(work_id, **kwargs) -> BetaSelfHostedWorkHeartbeatResponse
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat

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

停止工作
beta.environments.work.stop(work_id, **kwargs) -> BetaSelfHostedWork
POST/v1/environments/{environment_id}/work/{work_id}/stop

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

列出工作项
beta.environments.work.list(environment_id, **kwargs) -> SyncPageCursor[BetaSelfHostedWork]
GET/v1/environments/{environment_id}/work

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

更新工作项
beta.environments.work.update(work_id, **kwargs) -> BetaSelfHostedWork
POST/v1/environments/{environment_id}/work/{work_id}

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

获取队列统计信息
beta.environments.work.stats(environment_id, **kwargs) -> BetaSelfHostedWorkQueueStats
GET/v1/environments/{environment_id}/work/stats

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