Claude Platform Docs

Ambientes

Criar ambiente
client.Beta.Environments.New(ctx, params) (*BetaEnvironment, error)
POST/v1/environments

Crie um novo ambiente com a configuração especificada.

Listar ambientes
client.Beta.Environments.List(ctx, params) (*PageCursor[BetaEnvironment], error)
GET/v1/environments

Liste ambientes com suporte a paginação.

Obter ambiente
client.Beta.Environments.Get(ctx, environmentID, query) (*BetaEnvironment, error)
GET/v1/environments/{environment_id}

Recupere um ambiente específico por ID.

Atualizar ambiente
client.Beta.Environments.Update(ctx, environmentID, params) (*BetaEnvironment, error)
POST/v1/environments/{environment_id}

Atualize a configuração de um ambiente existente.

Excluir ambiente
client.Beta.Environments.Delete(ctx, environmentID, body) (*BetaEnvironmentDeleteResponse, error)
DELETE/v1/environments/{environment_id}

Exclua um ambiente por ID. Retorna uma confirmação da exclusão.

Arquivar ambiente
client.Beta.Environments.Archive(ctx, environmentID, body) (*BetaEnvironment, error)
POST/v1/environments/{environment_id}/archive

Arquive um ambiente por ID. Ambientes arquivados não podem ser usados para criar novas sessões.

Models
type BetaCloudConfig struct { Type: "cloud"; Networking; Packages }

cloud environment configuration.

type BetaCloudConfigParams struct { Type: "cloud"; Networking; Packages }

Request params for cloud environment configuration.

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

type BetaEnvironment struct { Type: "environment"; ID; ArchivedAt; /* 7 more */ }

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

type BetaEnvironmentDeleteResponse struct { Type: "environment_deleted"; ID }

Response after deleting an environment.

Type BetaEnvironmentDeleteResponseType

The type of response

defaultenvironment_deleted
ID string

Environment identifier

type BetaLimitedNetwork struct { Type: "limited"; AllowMCPServers; AllowPackageManagers; AllowedHosts }

Limited network access.

Type Limited

Network policy type

AllowMCPServers bool

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

AllowPackageManagers bool

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

AllowedHosts []string

Specifies domains the container can reach.

type BetaLimitedNetworkParams struct { Type: "limited"; AllowMCPServers; AllowPackageManagers; AllowedHosts }

Limited network request params.

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

Type Limited

Network policy type

AllowMCPServers bool Optional

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

AllowPackageManagers bool Optional

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.

AllowedHosts []string Optional

Specifies domains the container can reach.

type BetaPackages struct { Type: "packages"; Apt; Cargo; /* 4 more */ }

Packages (and their versions) available in this environment.

Type BetaPackagesType Optional

Package configuration type

defaultpackages
Apt []string

Ubuntu/Debian packages to install

Cargo []string

Rust packages to install

Gem []string

Ruby packages to install

Go []string

Go packages to install

Npm []string

Node.js packages to install

Pip []string

Python packages to install

type BetaPackagesParams struct { 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 BetaPackagesParamsType Optional

Package configuration type

defaultpackages
Apt []string Optional

Ubuntu/Debian packages to install

Cargo []string Optional

Rust packages to install

Gem []string Optional

Ruby packages to install

Go []string Optional

Go packages to install

Npm []string Optional

Node.js packages to install

Pip []string Optional

Python packages to install

type BetaSelfHostedConfig struct { Type: "self_hosted" }

Configuration for self-hosted environments.

Type SelfHosted

Environment type

type BetaSelfHostedConfigParams struct { Type: "self_hosted" }

Request params for self_hosted environment configuration.

Type SelfHosted

Environment type

type BetaUnrestrictedNetwork struct { Type: "unrestricted" }

Unrestricted network access.

Type Unrestricted

Network policy type

AmbientesTrabalho

Obter item de trabalho
client.Beta.Environments.Work.Get(ctx, workID, params) (*BetaSelfHostedWork, error)
GET/v1/environments/{environment_id}/work/{work_id}

Observação: esses endpoints são chamados automaticamente pelo worker de ambiente pré-construído fornecido nos SDKs e na CLI, para orquestrar sessões com ambientes sandbox auto-hospedados. Eles estão incluídos aqui como referência; você não precisa invocá-los diretamente.

Fazer polling por trabalho
client.Beta.Environments.Work.Poll(ctx, environmentID, params) (*BetaSelfHostedWork, error)
GET/v1/environments/{environment_id}/work/poll

Observação: esses endpoints são chamados automaticamente pelo worker de ambiente pré-construído fornecido nos SDKs e na CLI, para orquestrar sessões com ambientes sandbox auto-hospedados. Eles estão incluídos aqui como referência; você não precisa invocá-los diretamente.

Confirmar recebimento de trabalho
client.Beta.Environments.Work.Ack(ctx, workID, params) (*BetaSelfHostedWork, error)
POST/v1/environments/{environment_id}/work/{work_id}/ack

Observação: esses endpoints são chamados automaticamente pelo worker de ambiente pré-construído fornecido nos SDKs e na CLI, para orquestrar sessões com ambientes sandbox auto-hospedados. Eles estão incluídos aqui como referência; você não precisa invocá-los diretamente.

Registrar heartbeat
client.Beta.Environments.Work.Heartbeat(ctx, workID, params) (*BetaSelfHostedWorkHeartbeatResponse, error)
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat

Observação: esses endpoints são chamados automaticamente pelo worker de ambiente pré-construído fornecido nos SDKs e na CLI, para orquestrar sessões com ambientes sandbox auto-hospedados. Eles estão incluídos aqui como referência; você não precisa invocá-los diretamente.

Parar trabalho
client.Beta.Environments.Work.Stop(ctx, workID, params) (*BetaSelfHostedWork, error)
POST/v1/environments/{environment_id}/work/{work_id}/stop

Observação: esses endpoints são chamados automaticamente pelo worker de ambiente pré-construído fornecido nos SDKs e na CLI, para orquestrar sessões com ambientes sandbox auto-hospedados. Eles estão incluídos aqui como referência; você não precisa invocá-los diretamente.

Listar itens de trabalho
client.Beta.Environments.Work.List(ctx, environmentID, params) (*PageCursor[BetaSelfHostedWork], error)
GET/v1/environments/{environment_id}/work

Observação: esses endpoints são chamados automaticamente pelo worker de ambiente pré-construído fornecido nos SDKs e na CLI, para orquestrar sessões com ambientes sandbox auto-hospedados. Eles estão incluídos aqui como referência; você não precisa invocá-los diretamente.

Atualizar item de trabalho
client.Beta.Environments.Work.Update(ctx, workID, params) (*BetaSelfHostedWork, error)
POST/v1/environments/{environment_id}/work/{work_id}

Observação: esses endpoints são chamados automaticamente pelo worker de ambiente pré-construído fornecido nos SDKs e na CLI, para orquestrar sessões com ambientes sandbox auto-hospedados. Eles estão incluídos aqui como referência; você não precisa invocá-los diretamente.

Obter estatísticas da fila
client.Beta.Environments.Work.Stats(ctx, environmentID, query) (*BetaSelfHostedWorkQueueStats, error)
GET/v1/environments/{environment_id}/work/stats

Obtenha estatísticas sobre a fila de trabalho de um ambiente.