환경

환경 생성

client.Beta.Environments.New(ctx, params) (*BetaEnvironment, error)

POST/v1/environments

지정된 구성으로 새 환경을 생성합니다.

환경 목록 조회

client.Beta.Environments.List(ctx, params) (*PageCursor[BetaEnvironment], error)

GET/v1/environments

페이지네이션을 지원하는 환경 목록을 조회합니다.

환경 조회

client.Beta.Environments.Get(ctx, environmentID, query) (*BetaEnvironment, error)

GET/v1/environments/{environment_id}

ID로 특정 환경을 조회합니다.

환경 업데이트

client.Beta.Environments.Update(ctx, environmentID, params) (*BetaEnvironment, error)

POST/v1/environments/{environment_id}

기존 환경의 구성을 업데이트합니다.

환경 삭제

client.Beta.Environments.Delete(ctx, environmentID, body) (*BetaEnvironmentDeleteResponse, error)

DELETE/v1/environments/{environment_id}

ID로 환경을 삭제합니다. 삭제 확인을 반환합니다.

환경 보관

client.Beta.Environments.Archive(ctx, environmentID, body) (*BetaEnvironment, error)

POST/v1/environments/{environment_id}/archive

ID로 환경을 보관합니다. 보관된 환경은 새 세션을 생성하는 데 사용할 수 없습니다.

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

환경작업

작업 항목 조회

client.Beta.Environments.Work.Get(ctx, workID, params) (*BetaSelfHostedWork, error)

GET/v1/environments/{environment_id}/work/{work_id}

참고: 이 엔드포인트는 자체 호스팅 샌드박스 환경에서 세션을 오케스트레이션하기 위해 SDK 및 CLI에서 제공하는 사전 빌드된 환경 워커에 의해 자동으로 호출됩니다. 참조용으로 여기에 포함되어 있으며, 직접 호출할 필요는 없습니다.

작업 폴링

client.Beta.Environments.Work.Poll(ctx, environmentID, params) (*BetaSelfHostedWork, error)

GET/v1/environments/{environment_id}/work/poll

작업 확인

client.Beta.Environments.Work.Ack(ctx, workID, params) (*BetaSelfHostedWork, error)

POST/v1/environments/{environment_id}/work/{work_id}/ack

참고: 이러한 엔드포인트는 자체 호스팅 샌드박스 환경과의 세션을 오케스트레이션하기 위해 SDK 및 CLI에서 제공되는 사전 빌드된 환경 워커에 의해 자동으로 호출됩니다. 참조용으로 여기에 포함되어 있으며, 직접 호출할 필요는 없습니다.

환경의 작업 큐에 대한 통계를 가져옵니다.

환경

환경 생성

환경 목록 조회

환경 조회

환경 업데이트

환경 삭제

환경 보관

Models

환경작업

작업 항목 조회

작업 폴링

작업 확인

하트비트 기록

작업 중지

작업 항목 나열

작업 항목 업데이트

큐 통계 가져오기

환경

Models

환경작업

환경작업