Claude Platform Docs

Environnements

Créer un environnement
beta.environments.create(**kwargs) -> BetaEnvironment
POST/v1/environments

Créer un nouvel environnement avec la configuration spécifiée.

Lister les environnements
beta.environments.list(**kwargs) -> PageCursor<BetaEnvironment>
GET/v1/environments

Lister les environnements avec prise en charge de la pagination.

Obtenir un environnement
beta.environments.retrieve(environment_id, **kwargs) -> BetaEnvironment
GET/v1/environments/{environment_id}

Récupérer un environnement spécifique par son identifiant.

Mettre à jour un environnement
beta.environments.update(environment_id, **kwargs) -> BetaEnvironment
POST/v1/environments/{environment_id}

Mettre à jour la configuration d'un environnement existant.

Supprimer un environnement
beta.environments.delete(environment_id, **kwargs) -> BetaEnvironmentDeleteResponse
DELETE/v1/environments/{environment_id}

Supprimer un environnement par son identifiant. Renvoie une confirmation de la suppression.

Archiver un environnement
beta.environments.archive(environment_id, **kwargs) -> BetaEnvironment
POST/v1/environments/{environment_id}/archive

Archiver un environnement par son identifiant. Les environnements archivés ne peuvent pas être utilisés pour créer de nouvelles sessions.

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: :environment_deleted

The type of response

id: String

Environment identifier

class BetaLimitedNetwork { type: :limited, allow_mcp_servers, allow_package_managers, allowed_hosts }

Limited network access.

type: :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: Array[String]

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: :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. Defaults to false.

allow_package_managers: 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: Array[String]

Specifies domains the container can reach.

class BetaPackages { type: :packages, apt, cargo, 4 more }

Packages (and their versions) available in this environment.

type: :packages

Package configuration type

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

class 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.

type: :packages

Package configuration type

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

class BetaSelfHostedConfig { type: :self_hosted }

Configuration for self-hosted environments.

type: :self_hosted

Environment type

class BetaSelfHostedConfigParams { type: :self_hosted }

Request params for self_hosted environment configuration.

type: :self_hosted

Environment type

class BetaUnrestrictedNetwork { type: :unrestricted }

Unrestricted network access.

type: :unrestricted

Network policy type

EnvironnementsTravail

Obtenir un élément de travail
beta.environments.work.retrieve(work_id, **kwargs) -> BetaSelfHostedWork
GET/v1/environments/{environment_id}/work/{work_id}

Remarque : ces points de terminaison sont appelés automatiquement par le worker d'environnement préconstruit fourni dans les SDK et la CLI, afin d'orchestrer les sessions avec des environnements sandbox auto-hébergés. Ils sont inclus ici à titre de référence ; vous n'avez pas besoin de les invoquer directement.

Interroger pour obtenir du travail
beta.environments.work.poll(environment_id, **kwargs) -> BetaSelfHostedWork
GET/v1/environments/{environment_id}/work/poll

Remarque : ces points de terminaison sont appelés automatiquement par le worker d'environnement préconstruit fourni dans les SDK et la CLI, afin d'orchestrer les sessions avec des environnements sandbox auto-hébergés. Ils sont inclus ici à titre de référence ; vous n'avez pas besoin de les invoquer directement.

Accuser réception d'un travail
beta.environments.work.ack(work_id, **kwargs) -> BetaSelfHostedWork
POST/v1/environments/{environment_id}/work/{work_id}/ack

Remarque : ces points de terminaison sont appelés automatiquement par le worker d'environnement préconstruit fourni dans les SDK et la CLI, afin d'orchestrer les sessions avec des environnements sandbox auto-hébergés. Ils sont inclus ici à titre de référence ; vous n'avez pas besoin de les invoquer directement.

Enregistrer un signal de présence
beta.environments.work.heartbeat(work_id, **kwargs) -> BetaSelfHostedWorkHeartbeatResponse
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat

Remarque : ces points de terminaison sont appelés automatiquement par le worker d'environnement préconstruit fourni dans les SDK et la CLI, afin d'orchestrer les sessions avec des environnements sandbox auto-hébergés. Ils sont inclus ici à titre de référence ; vous n'avez pas besoin de les invoquer directement.

Arrêter un travail
beta.environments.work.stop(work_id, **kwargs) -> BetaSelfHostedWork
POST/v1/environments/{environment_id}/work/{work_id}/stop

Remarque : ces points de terminaison sont appelés automatiquement par le worker d'environnement préconstruit fourni dans les SDK et la CLI, afin d'orchestrer les sessions avec des environnements sandbox auto-hébergés. Ils sont inclus ici à titre de référence ; vous n'avez pas besoin de les invoquer directement.

Lister les éléments de travail
beta.environments.work.list(environment_id, **kwargs) -> PageCursor<BetaSelfHostedWork>
GET/v1/environments/{environment_id}/work

Remarque : ces points de terminaison sont appelés automatiquement par le worker d'environnement préconstruit fourni dans les SDK et la CLI, afin d'orchestrer les sessions avec des environnements sandbox auto-hébergés. Ils sont inclus ici à titre de référence ; vous n'avez pas besoin de les invoquer directement.

Mettre à jour un élément de travail
beta.environments.work.update(work_id, **kwargs) -> BetaSelfHostedWork
POST/v1/environments/{environment_id}/work/{work_id}

Remarque : ces points de terminaison sont appelés automatiquement par le worker d'environnement préconstruit fourni dans les SDK et la CLI, afin d'orchestrer les sessions avec des environnements sandbox auto-hébergés. Ils sont inclus ici à titre de référence ; vous n'avez pas besoin de les invoquer directement.

Obtenir les statistiques de la file d'attente
beta.environments.work.stats(environment_id, **kwargs) -> BetaSelfHostedWorkQueueStats
GET/v1/environments/{environment_id}/work/stats

Obtenir des statistiques sur la file d'attente de travail d'un environnement.