# Environments ## Create Environment `client.beta.environments.create(EnvironmentCreateParamsparams, RequestOptionsoptions?): BetaEnvironment` **post** `/v1/environments` Create a new environment with the specified configuration. ### Parameters - `params: EnvironmentCreateParams` - `name: string` Body param: Human-readable name for the environment - `config?: BetaCloudConfigParams | BetaSelfHostedConfigParams | null` Body param: Environment configuration - `BetaCloudConfigParams` Request params for `cloud` environment configuration. Fields default to null; on update, omitted fields preserve the existing value. - `type: "cloud"` Environment type - `"cloud"` - `networking?: BetaUnrestrictedNetwork | BetaLimitedNetworkParams | null` Network configuration policy. Omit on update to preserve the existing value. - `BetaUnrestrictedNetwork` Unrestricted network access. - `type: "unrestricted"` Network policy type - `"unrestricted"` - `BetaLimitedNetworkParams` Limited network request params. Fields default to null; on update, omitted fields preserve the existing value. - `type: "limited"` Network policy type - `"limited"` - `allow_mcp_servers?: boolean | null` 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?: boolean | null` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. - `allowed_hosts?: Array | null` Specifies domains the container can reach. - `packages?: BetaPackagesParams | null` 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. - `apt?: Array | null` Ubuntu/Debian packages to install - `cargo?: Array | null` Rust packages to install - `gem?: Array | null` Ruby packages to install - `go?: Array | null` Go packages to install - `npm?: Array | null` Node.js packages to install - `pip?: Array | null` Python packages to install - `type?: "packages"` Package configuration type - `"packages"` - `BetaSelfHostedConfigParams` Request params for `self_hosted` environment configuration. - `type: "self_hosted"` Environment type - `"self_hosted"` - `description?: string | null` Body param: Optional description of the environment - `metadata?: Record` Body param: User-provided metadata key-value pairs - `scope?: "organization" | "account" | null` Body param: The visibility scope for this environment. 'organization' makes the environment visible to all accounts. 'account' restricts visibility to the owning account only. Only applicable for self-hosted environments. If not specified, defaults based on organization type. - `"organization"` - `"account"` - `betas?: Array` Header param: Optional header to specify the beta version(s) you want to use. - `(string & {})` - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 23 more` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"thinking-token-count-2026-05-13"` ### Returns - `BetaEnvironment` Unified Environment resource for both cloud and self-hosted environments. - `id: string` Environment identifier (e.g., 'env_...') - `archived_at: string | null` RFC 3339 timestamp when environment was archived, or null if not archived - `config: BetaCloudConfig | BetaSelfHostedConfig` Environment configuration (either Anthropic Cloud or self-hosted) - `BetaCloudConfig` `cloud` environment configuration. - `networking: BetaUnrestrictedNetwork | BetaLimitedNetwork` Network configuration policy. - `BetaUnrestrictedNetwork` Unrestricted network access. - `type: "unrestricted"` Network policy type - `"unrestricted"` - `BetaLimitedNetwork` Limited network access. - `allow_mcp_servers: boolean` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. - `allow_package_managers: boolean` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. - `allowed_hosts: Array` Specifies domains the container can reach. - `type: "limited"` Network policy type - `"limited"` - `packages: BetaPackages` Package manager configuration. - `apt: Array` Ubuntu/Debian packages to install - `cargo: Array` Rust packages to install - `gem: Array` Ruby packages to install - `go: Array` Go packages to install - `npm: Array` Node.js packages to install - `pip: Array` Python packages to install - `type?: "packages"` Package configuration type - `"packages"` - `type: "cloud"` Environment type - `"cloud"` - `BetaSelfHostedConfig` Configuration for self-hosted environments. - `type: "self_hosted"` Environment type - `"self_hosted"` - `created_at: string` RFC 3339 timestamp when environment was created - `description: string` User-provided description for the environment - `metadata: Record` User-provided metadata key-value pairs - `name: string` Human-readable name for the environment - `type: "environment"` The type of object (always 'environment') - `"environment"` - `updated_at: string` RFC 3339 timestamp when environment was last updated - `scope?: "organization" | "account"` The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account. - `"organization"` - `"account"` ### Example ```typescript import Anthropic from '@anthropic-ai/sdk'; const client = new Anthropic({ apiKey: process.env['ANTHROPIC_API_KEY'], // This is the default and can be omitted }); const betaEnvironment = await client.beta.environments.create({ name: 'python-data-analysis' }); console.log(betaEnvironment.id); ``` #### Response ```json { "id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "archived_at": null, "config": { "networking": { "allow_mcp_servers": false, "allow_package_managers": true, "allowed_hosts": [ "api.example.com" ], "type": "limited" }, "packages": { "apt": [ "string" ], "cargo": [ "string" ], "gem": [ "string" ], "go": [ "string" ], "npm": [ "string" ], "pip": [ "pandas", "numpy" ], "type": "packages" }, "type": "cloud" }, "created_at": "2026-03-15T10:00:00Z", "description": "Python environment with data-analysis packages.", "metadata": {}, "name": "python-data-analysis", "type": "environment", "updated_at": "2026-03-15T10:00:00Z", "scope": "organization" } ``` ## List Environments `client.beta.environments.list(EnvironmentListParamsparams?, RequestOptionsoptions?): PageCursor` **get** `/v1/environments` List environments with pagination support. ### Parameters - `params: EnvironmentListParams` - `include_archived?: boolean` Query param: Include archived environments in the response - `limit?: number` Query param: Maximum number of environments to return - `page?: string | null` Query param: Opaque cursor from previous response for pagination. Pass the `next_page` value from the previous response. - `betas?: Array` Header param: Optional header to specify the beta version(s) you want to use. - `(string & {})` - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 23 more` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"thinking-token-count-2026-05-13"` ### Returns - `BetaEnvironment` Unified Environment resource for both cloud and self-hosted environments. - `id: string` Environment identifier (e.g., 'env_...') - `archived_at: string | null` RFC 3339 timestamp when environment was archived, or null if not archived - `config: BetaCloudConfig | BetaSelfHostedConfig` Environment configuration (either Anthropic Cloud or self-hosted) - `BetaCloudConfig` `cloud` environment configuration. - `networking: BetaUnrestrictedNetwork | BetaLimitedNetwork` Network configuration policy. - `BetaUnrestrictedNetwork` Unrestricted network access. - `type: "unrestricted"` Network policy type - `"unrestricted"` - `BetaLimitedNetwork` Limited network access. - `allow_mcp_servers: boolean` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. - `allow_package_managers: boolean` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. - `allowed_hosts: Array` Specifies domains the container can reach. - `type: "limited"` Network policy type - `"limited"` - `packages: BetaPackages` Package manager configuration. - `apt: Array` Ubuntu/Debian packages to install - `cargo: Array` Rust packages to install - `gem: Array` Ruby packages to install - `go: Array` Go packages to install - `npm: Array` Node.js packages to install - `pip: Array` Python packages to install - `type?: "packages"` Package configuration type - `"packages"` - `type: "cloud"` Environment type - `"cloud"` - `BetaSelfHostedConfig` Configuration for self-hosted environments. - `type: "self_hosted"` Environment type - `"self_hosted"` - `created_at: string` RFC 3339 timestamp when environment was created - `description: string` User-provided description for the environment - `metadata: Record` User-provided metadata key-value pairs - `name: string` Human-readable name for the environment - `type: "environment"` The type of object (always 'environment') - `"environment"` - `updated_at: string` RFC 3339 timestamp when environment was last updated - `scope?: "organization" | "account"` The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account. - `"organization"` - `"account"` ### Example ```typescript import Anthropic from '@anthropic-ai/sdk'; const client = new Anthropic({ apiKey: process.env['ANTHROPIC_API_KEY'], // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const betaEnvironment of client.beta.environments.list()) { console.log(betaEnvironment.id); } ``` #### Response ```json { "data": [ { "id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "archived_at": null, "config": { "networking": { "allow_mcp_servers": false, "allow_package_managers": true, "allowed_hosts": [ "api.example.com" ], "type": "limited" }, "packages": { "apt": [ "string" ], "cargo": [ "string" ], "gem": [ "string" ], "go": [ "string" ], "npm": [ "string" ], "pip": [ "pandas", "numpy" ], "type": "packages" }, "type": "cloud" }, "created_at": "2026-03-15T10:00:00Z", "description": "Python environment with data-analysis packages.", "metadata": {}, "name": "python-data-analysis", "type": "environment", "updated_at": "2026-03-15T10:00:00Z", "scope": "organization" } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ## Get Environment `client.beta.environments.retrieve(stringenvironmentID, EnvironmentRetrieveParamsparams?, RequestOptionsoptions?): BetaEnvironment` **get** `/v1/environments/{environment_id}` Retrieve a specific environment by ID. ### Parameters - `environmentID: string` - `params: EnvironmentRetrieveParams` - `betas?: Array` Optional header to specify the beta version(s) you want to use. - `(string & {})` - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 23 more` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"thinking-token-count-2026-05-13"` ### Returns - `BetaEnvironment` Unified Environment resource for both cloud and self-hosted environments. - `id: string` Environment identifier (e.g., 'env_...') - `archived_at: string | null` RFC 3339 timestamp when environment was archived, or null if not archived - `config: BetaCloudConfig | BetaSelfHostedConfig` Environment configuration (either Anthropic Cloud or self-hosted) - `BetaCloudConfig` `cloud` environment configuration. - `networking: BetaUnrestrictedNetwork | BetaLimitedNetwork` Network configuration policy. - `BetaUnrestrictedNetwork` Unrestricted network access. - `type: "unrestricted"` Network policy type - `"unrestricted"` - `BetaLimitedNetwork` Limited network access. - `allow_mcp_servers: boolean` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. - `allow_package_managers: boolean` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. - `allowed_hosts: Array` Specifies domains the container can reach. - `type: "limited"` Network policy type - `"limited"` - `packages: BetaPackages` Package manager configuration. - `apt: Array` Ubuntu/Debian packages to install - `cargo: Array` Rust packages to install - `gem: Array` Ruby packages to install - `go: Array` Go packages to install - `npm: Array` Node.js packages to install - `pip: Array` Python packages to install - `type?: "packages"` Package configuration type - `"packages"` - `type: "cloud"` Environment type - `"cloud"` - `BetaSelfHostedConfig` Configuration for self-hosted environments. - `type: "self_hosted"` Environment type - `"self_hosted"` - `created_at: string` RFC 3339 timestamp when environment was created - `description: string` User-provided description for the environment - `metadata: Record` User-provided metadata key-value pairs - `name: string` Human-readable name for the environment - `type: "environment"` The type of object (always 'environment') - `"environment"` - `updated_at: string` RFC 3339 timestamp when environment was last updated - `scope?: "organization" | "account"` The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account. - `"organization"` - `"account"` ### Example ```typescript import Anthropic from '@anthropic-ai/sdk'; const client = new Anthropic({ apiKey: process.env['ANTHROPIC_API_KEY'], // This is the default and can be omitted }); const betaEnvironment = await client.beta.environments.retrieve('env_011CZkZ9X2dpNyB7HsEFoRfW'); console.log(betaEnvironment.id); ``` #### Response ```json { "id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "archived_at": null, "config": { "networking": { "allow_mcp_servers": false, "allow_package_managers": true, "allowed_hosts": [ "api.example.com" ], "type": "limited" }, "packages": { "apt": [ "string" ], "cargo": [ "string" ], "gem": [ "string" ], "go": [ "string" ], "npm": [ "string" ], "pip": [ "pandas", "numpy" ], "type": "packages" }, "type": "cloud" }, "created_at": "2026-03-15T10:00:00Z", "description": "Python environment with data-analysis packages.", "metadata": {}, "name": "python-data-analysis", "type": "environment", "updated_at": "2026-03-15T10:00:00Z", "scope": "organization" } ``` ## Update Environment `client.beta.environments.update(stringenvironmentID, EnvironmentUpdateParamsparams, RequestOptionsoptions?): BetaEnvironment` **post** `/v1/environments/{environment_id}` Update an existing environment's configuration. ### Parameters - `environmentID: string` - `params: EnvironmentUpdateParams` - `config?: BetaCloudConfigParams | BetaSelfHostedConfigParams | null` Body param: Updated environment configuration - `BetaCloudConfigParams` Request params for `cloud` environment configuration. Fields default to null; on update, omitted fields preserve the existing value. - `type: "cloud"` Environment type - `"cloud"` - `networking?: BetaUnrestrictedNetwork | BetaLimitedNetworkParams | null` Network configuration policy. Omit on update to preserve the existing value. - `BetaUnrestrictedNetwork` Unrestricted network access. - `type: "unrestricted"` Network policy type - `"unrestricted"` - `BetaLimitedNetworkParams` Limited network request params. Fields default to null; on update, omitted fields preserve the existing value. - `type: "limited"` Network policy type - `"limited"` - `allow_mcp_servers?: boolean | null` 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?: boolean | null` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. - `allowed_hosts?: Array | null` Specifies domains the container can reach. - `packages?: BetaPackagesParams | null` 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. - `apt?: Array | null` Ubuntu/Debian packages to install - `cargo?: Array | null` Rust packages to install - `gem?: Array | null` Ruby packages to install - `go?: Array | null` Go packages to install - `npm?: Array | null` Node.js packages to install - `pip?: Array | null` Python packages to install - `type?: "packages"` Package configuration type - `"packages"` - `BetaSelfHostedConfigParams` Request params for `self_hosted` environment configuration. - `type: "self_hosted"` Environment type - `"self_hosted"` - `description?: string | null` Body param: Updated description of the environment - `metadata?: Record` Body param: User-provided metadata key-value pairs. Set a value to null or empty string to delete the key. - `name?: string | null` Body param: Updated name for the environment - `scope?: "organization" | "account" | null` Body param: The visibility scope for this environment. 'organization' makes the environment visible to all accounts. 'account' restricts visibility to the owning account only. - `"organization"` - `"account"` - `betas?: Array` Header param: Optional header to specify the beta version(s) you want to use. - `(string & {})` - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 23 more` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"thinking-token-count-2026-05-13"` ### Returns - `BetaEnvironment` Unified Environment resource for both cloud and self-hosted environments. - `id: string` Environment identifier (e.g., 'env_...') - `archived_at: string | null` RFC 3339 timestamp when environment was archived, or null if not archived - `config: BetaCloudConfig | BetaSelfHostedConfig` Environment configuration (either Anthropic Cloud or self-hosted) - `BetaCloudConfig` `cloud` environment configuration. - `networking: BetaUnrestrictedNetwork | BetaLimitedNetwork` Network configuration policy. - `BetaUnrestrictedNetwork` Unrestricted network access. - `type: "unrestricted"` Network policy type - `"unrestricted"` - `BetaLimitedNetwork` Limited network access. - `allow_mcp_servers: boolean` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. - `allow_package_managers: boolean` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. - `allowed_hosts: Array` Specifies domains the container can reach. - `type: "limited"` Network policy type - `"limited"` - `packages: BetaPackages` Package manager configuration. - `apt: Array` Ubuntu/Debian packages to install - `cargo: Array` Rust packages to install - `gem: Array` Ruby packages to install - `go: Array` Go packages to install - `npm: Array` Node.js packages to install - `pip: Array` Python packages to install - `type?: "packages"` Package configuration type - `"packages"` - `type: "cloud"` Environment type - `"cloud"` - `BetaSelfHostedConfig` Configuration for self-hosted environments. - `type: "self_hosted"` Environment type - `"self_hosted"` - `created_at: string` RFC 3339 timestamp when environment was created - `description: string` User-provided description for the environment - `metadata: Record` User-provided metadata key-value pairs - `name: string` Human-readable name for the environment - `type: "environment"` The type of object (always 'environment') - `"environment"` - `updated_at: string` RFC 3339 timestamp when environment was last updated - `scope?: "organization" | "account"` The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account. - `"organization"` - `"account"` ### Example ```typescript import Anthropic from '@anthropic-ai/sdk'; const client = new Anthropic({ apiKey: process.env['ANTHROPIC_API_KEY'], // This is the default and can be omitted }); const betaEnvironment = await client.beta.environments.update('env_011CZkZ9X2dpNyB7HsEFoRfW'); console.log(betaEnvironment.id); ``` #### Response ```json { "id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "archived_at": null, "config": { "networking": { "allow_mcp_servers": false, "allow_package_managers": true, "allowed_hosts": [ "api.example.com" ], "type": "limited" }, "packages": { "apt": [ "string" ], "cargo": [ "string" ], "gem": [ "string" ], "go": [ "string" ], "npm": [ "string" ], "pip": [ "pandas", "numpy" ], "type": "packages" }, "type": "cloud" }, "created_at": "2026-03-15T10:00:00Z", "description": "Python environment with data-analysis packages.", "metadata": {}, "name": "python-data-analysis", "type": "environment", "updated_at": "2026-03-15T10:00:00Z", "scope": "organization" } ``` ## Delete Environment `client.beta.environments.delete(stringenvironmentID, EnvironmentDeleteParamsparams?, RequestOptionsoptions?): BetaEnvironmentDeleteResponse` **delete** `/v1/environments/{environment_id}` Delete an environment by ID. Returns a confirmation of the deletion. ### Parameters - `environmentID: string` - `params: EnvironmentDeleteParams` - `betas?: Array` Optional header to specify the beta version(s) you want to use. - `(string & {})` - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 23 more` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"thinking-token-count-2026-05-13"` ### Returns - `BetaEnvironmentDeleteResponse` Response after deleting an environment. - `id: string` Environment identifier - `type: "environment_deleted"` The type of response - `"environment_deleted"` ### Example ```typescript import Anthropic from '@anthropic-ai/sdk'; const client = new Anthropic({ apiKey: process.env['ANTHROPIC_API_KEY'], // This is the default and can be omitted }); const betaEnvironmentDeleteResponse = await client.beta.environments.delete( 'env_011CZkZ9X2dpNyB7HsEFoRfW', ); console.log(betaEnvironmentDeleteResponse.id); ``` #### Response ```json { "id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "type": "environment_deleted" } ``` ## Archive Environment `client.beta.environments.archive(stringenvironmentID, EnvironmentArchiveParamsparams?, RequestOptionsoptions?): BetaEnvironment` **post** `/v1/environments/{environment_id}/archive` Archive an environment by ID. Archived environments cannot be used to create new sessions. ### Parameters - `environmentID: string` - `params: EnvironmentArchiveParams` - `betas?: Array` Optional header to specify the beta version(s) you want to use. - `(string & {})` - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 23 more` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"thinking-token-count-2026-05-13"` ### Returns - `BetaEnvironment` Unified Environment resource for both cloud and self-hosted environments. - `id: string` Environment identifier (e.g., 'env_...') - `archived_at: string | null` RFC 3339 timestamp when environment was archived, or null if not archived - `config: BetaCloudConfig | BetaSelfHostedConfig` Environment configuration (either Anthropic Cloud or self-hosted) - `BetaCloudConfig` `cloud` environment configuration. - `networking: BetaUnrestrictedNetwork | BetaLimitedNetwork` Network configuration policy. - `BetaUnrestrictedNetwork` Unrestricted network access. - `type: "unrestricted"` Network policy type - `"unrestricted"` - `BetaLimitedNetwork` Limited network access. - `allow_mcp_servers: boolean` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. - `allow_package_managers: boolean` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. - `allowed_hosts: Array` Specifies domains the container can reach. - `type: "limited"` Network policy type - `"limited"` - `packages: BetaPackages` Package manager configuration. - `apt: Array` Ubuntu/Debian packages to install - `cargo: Array` Rust packages to install - `gem: Array` Ruby packages to install - `go: Array` Go packages to install - `npm: Array` Node.js packages to install - `pip: Array` Python packages to install - `type?: "packages"` Package configuration type - `"packages"` - `type: "cloud"` Environment type - `"cloud"` - `BetaSelfHostedConfig` Configuration for self-hosted environments. - `type: "self_hosted"` Environment type - `"self_hosted"` - `created_at: string` RFC 3339 timestamp when environment was created - `description: string` User-provided description for the environment - `metadata: Record` User-provided metadata key-value pairs - `name: string` Human-readable name for the environment - `type: "environment"` The type of object (always 'environment') - `"environment"` - `updated_at: string` RFC 3339 timestamp when environment was last updated - `scope?: "organization" | "account"` The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account. - `"organization"` - `"account"` ### Example ```typescript import Anthropic from '@anthropic-ai/sdk'; const client = new Anthropic({ apiKey: process.env['ANTHROPIC_API_KEY'], // This is the default and can be omitted }); const betaEnvironment = await client.beta.environments.archive('env_011CZkZ9X2dpNyB7HsEFoRfW'); console.log(betaEnvironment.id); ``` #### Response ```json { "id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "archived_at": null, "config": { "networking": { "allow_mcp_servers": false, "allow_package_managers": true, "allowed_hosts": [ "api.example.com" ], "type": "limited" }, "packages": { "apt": [ "string" ], "cargo": [ "string" ], "gem": [ "string" ], "go": [ "string" ], "npm": [ "string" ], "pip": [ "pandas", "numpy" ], "type": "packages" }, "type": "cloud" }, "created_at": "2026-03-15T10:00:00Z", "description": "Python environment with data-analysis packages.", "metadata": {}, "name": "python-data-analysis", "type": "environment", "updated_at": "2026-03-15T10:00:00Z", "scope": "organization" } ``` ## Domain Types ### Beta Cloud Config - `BetaCloudConfig` `cloud` environment configuration. - `networking: BetaUnrestrictedNetwork | BetaLimitedNetwork` Network configuration policy. - `BetaUnrestrictedNetwork` Unrestricted network access. - `type: "unrestricted"` Network policy type - `"unrestricted"` - `BetaLimitedNetwork` Limited network access. - `allow_mcp_servers: boolean` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. - `allow_package_managers: boolean` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. - `allowed_hosts: Array` Specifies domains the container can reach. - `type: "limited"` Network policy type - `"limited"` - `packages: BetaPackages` Package manager configuration. - `apt: Array` Ubuntu/Debian packages to install - `cargo: Array` Rust packages to install - `gem: Array` Ruby packages to install - `go: Array` Go packages to install - `npm: Array` Node.js packages to install - `pip: Array` Python packages to install - `type?: "packages"` Package configuration type - `"packages"` - `type: "cloud"` Environment type - `"cloud"` ### Beta Cloud Config Params - `BetaCloudConfigParams` Request params for `cloud` environment configuration. Fields default to null; on update, omitted fields preserve the existing value. - `type: "cloud"` Environment type - `"cloud"` - `networking?: BetaUnrestrictedNetwork | BetaLimitedNetworkParams | null` Network configuration policy. Omit on update to preserve the existing value. - `BetaUnrestrictedNetwork` Unrestricted network access. - `type: "unrestricted"` Network policy type - `"unrestricted"` - `BetaLimitedNetworkParams` Limited network request params. Fields default to null; on update, omitted fields preserve the existing value. - `type: "limited"` Network policy type - `"limited"` - `allow_mcp_servers?: boolean | null` 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?: boolean | null` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. - `allowed_hosts?: Array | null` Specifies domains the container can reach. - `packages?: BetaPackagesParams | null` 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. - `apt?: Array | null` Ubuntu/Debian packages to install - `cargo?: Array | null` Rust packages to install - `gem?: Array | null` Ruby packages to install - `go?: Array | null` Go packages to install - `npm?: Array | null` Node.js packages to install - `pip?: Array | null` Python packages to install - `type?: "packages"` Package configuration type - `"packages"` ### Beta Environment - `BetaEnvironment` Unified Environment resource for both cloud and self-hosted environments. - `id: string` Environment identifier (e.g., 'env_...') - `archived_at: string | null` RFC 3339 timestamp when environment was archived, or null if not archived - `config: BetaCloudConfig | BetaSelfHostedConfig` Environment configuration (either Anthropic Cloud or self-hosted) - `BetaCloudConfig` `cloud` environment configuration. - `networking: BetaUnrestrictedNetwork | BetaLimitedNetwork` Network configuration policy. - `BetaUnrestrictedNetwork` Unrestricted network access. - `type: "unrestricted"` Network policy type - `"unrestricted"` - `BetaLimitedNetwork` Limited network access. - `allow_mcp_servers: boolean` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. - `allow_package_managers: boolean` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. - `allowed_hosts: Array` Specifies domains the container can reach. - `type: "limited"` Network policy type - `"limited"` - `packages: BetaPackages` Package manager configuration. - `apt: Array` Ubuntu/Debian packages to install - `cargo: Array` Rust packages to install - `gem: Array` Ruby packages to install - `go: Array` Go packages to install - `npm: Array` Node.js packages to install - `pip: Array` Python packages to install - `type?: "packages"` Package configuration type - `"packages"` - `type: "cloud"` Environment type - `"cloud"` - `BetaSelfHostedConfig` Configuration for self-hosted environments. - `type: "self_hosted"` Environment type - `"self_hosted"` - `created_at: string` RFC 3339 timestamp when environment was created - `description: string` User-provided description for the environment - `metadata: Record` User-provided metadata key-value pairs - `name: string` Human-readable name for the environment - `type: "environment"` The type of object (always 'environment') - `"environment"` - `updated_at: string` RFC 3339 timestamp when environment was last updated - `scope?: "organization" | "account"` The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account. - `"organization"` - `"account"` ### Beta Environment Delete Response - `BetaEnvironmentDeleteResponse` Response after deleting an environment. - `id: string` Environment identifier - `type: "environment_deleted"` The type of response - `"environment_deleted"` ### Beta Limited Network - `BetaLimitedNetwork` Limited network access. - `allow_mcp_servers: boolean` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. - `allow_package_managers: boolean` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. - `allowed_hosts: Array` Specifies domains the container can reach. - `type: "limited"` Network policy type - `"limited"` ### Beta Limited Network Params - `BetaLimitedNetworkParams` Limited network request params. Fields default to null; on update, omitted fields preserve the existing value. - `type: "limited"` Network policy type - `"limited"` - `allow_mcp_servers?: boolean | null` 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?: boolean | null` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. - `allowed_hosts?: Array | null` Specifies domains the container can reach. ### Beta Packages - `BetaPackages` Packages (and their versions) available in this environment. - `apt: Array` Ubuntu/Debian packages to install - `cargo: Array` Rust packages to install - `gem: Array` Ruby packages to install - `go: Array` Go packages to install - `npm: Array` Node.js packages to install - `pip: Array` Python packages to install - `type?: "packages"` Package configuration type - `"packages"` ### Beta Packages Params - `BetaPackagesParams` 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. - `apt?: Array | null` Ubuntu/Debian packages to install - `cargo?: Array | null` Rust packages to install - `gem?: Array | null` Ruby packages to install - `go?: Array | null` Go packages to install - `npm?: Array | null` Node.js packages to install - `pip?: Array | null` Python packages to install - `type?: "packages"` Package configuration type - `"packages"` ### Beta Self Hosted Config - `BetaSelfHostedConfig` Configuration for self-hosted environments. - `type: "self_hosted"` Environment type - `"self_hosted"` ### Beta Self Hosted Config Params - `BetaSelfHostedConfigParams` Request params for `self_hosted` environment configuration. - `type: "self_hosted"` Environment type - `"self_hosted"` ### Beta Unrestricted Network - `BetaUnrestrictedNetwork` Unrestricted network access. - `type: "unrestricted"` Network policy type - `"unrestricted"` # Work ## Get Work Item `client.beta.environments.work.retrieve(stringworkID, WorkRetrieveParamsparams, RequestOptionsoptions?): BetaSelfHostedWork` **get** `/v1/environments/{environment_id}/work/{work_id}` Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly. Retrieve detailed information about a specific work item. ### Parameters - `workID: string` - `params: WorkRetrieveParams` - `environment_id: string` Path param - `betas?: Array` Header param: Optional header to specify the beta version(s) you want to use. - `(string & {})` - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 23 more` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"thinking-token-count-2026-05-13"` ### Returns - `BetaSelfHostedWork` Work resource representing a unit of work in a self-hosted environment. Work items are queued when sessions are created or when long-dormant sessions receive new messages. The environment worker polls for work to execute in a self-hosted sandbox. - `id: string` Work identifier (e.g., 'work_...') - `acknowledged_at: string | null` RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox - `created_at: string` RFC 3339 timestamp when work was created - `data: BetaSessionWorkData` The actual work to be performed - `id: string` Session identifier (e.g., 'session_...') - `type: "session"` Type of work data - `"session"` - `environment_id: string` Environment identifier this work belongs to (e.g., `env_...`) - `latest_heartbeat_at: string | null` RFC 3339 timestamp of the most recent heartbeat - `metadata: Record` User-provided metadata key-value pairs associated with this work item - `started_at: string | null` RFC 3339 timestamp when work execution started - `state: "queued" | "starting" | "active" | 2 more` Current state of the work item - `"queued"` - `"starting"` - `"active"` - `"stopping"` - `"stopped"` - `stop_requested_at: string | null` RFC 3339 timestamp when stop was requested - `stopped_at: string | null` RFC 3339 timestamp when work execution stopped - `type: "work"` The type of object (always 'work') - `"work"` ### Example ```typescript import Anthropic from '@anthropic-ai/sdk'; const client = new Anthropic({ apiKey: process.env['ANTHROPIC_API_KEY'], // This is the default and can be omitted }); const betaSelfHostedWork = await client.beta.environments.work.retrieve('work_id', { environment_id: 'env_011CZkZ9X2dpNyB7HsEFoRfW', }); console.log(betaSelfHostedWork.id); ``` #### Response ```json { "id": "id", "acknowledged_at": "acknowledged_at", "created_at": "created_at", "data": { "id": "id", "type": "session" }, "environment_id": "environment_id", "latest_heartbeat_at": "latest_heartbeat_at", "metadata": { "foo": "string" }, "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } ``` ## Poll for Work `client.beta.environments.work.poll(stringenvironmentID, WorkPollParamsparams?, RequestOptionsoptions?): BetaSelfHostedWork | null` **get** `/v1/environments/{environment_id}/work/poll` Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly. Long poll for work items in the queue. ### Parameters - `environmentID: string` - `params: WorkPollParams` - `block_ms?: number | null` Query param: How long to wait for work to arrive before returning. Must be 1-999 in milliseconds. Defaults to non-blocking (returns immediately if no work is available). - `reclaim_older_than_ms?: number | null` Query param: Reclaim unacknowledged work items older than this many milliseconds. If omitted, uses the default (5000ms). - `betas?: Array` Header param: Optional header to specify the beta version(s) you want to use. - `(string & {})` - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 23 more` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"thinking-token-count-2026-05-13"` - `"Anthropic-Worker-ID"?: string` Header param: Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console ### Returns - `BetaSelfHostedWork | null` - `id: string` Work identifier (e.g., 'work_...') - `acknowledged_at: string | null` RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox - `created_at: string` RFC 3339 timestamp when work was created - `data: BetaSessionWorkData` The actual work to be performed - `id: string` Session identifier (e.g., 'session_...') - `type: "session"` Type of work data - `"session"` - `environment_id: string` Environment identifier this work belongs to (e.g., `env_...`) - `latest_heartbeat_at: string | null` RFC 3339 timestamp of the most recent heartbeat - `metadata: Record` User-provided metadata key-value pairs associated with this work item - `started_at: string | null` RFC 3339 timestamp when work execution started - `state: "queued" | "starting" | "active" | 2 more` Current state of the work item - `"queued"` - `"starting"` - `"active"` - `"stopping"` - `"stopped"` - `stop_requested_at: string | null` RFC 3339 timestamp when stop was requested - `stopped_at: string | null` RFC 3339 timestamp when work execution stopped - `type: "work"` The type of object (always 'work') - `"work"` ### Example ```typescript import Anthropic from '@anthropic-ai/sdk'; const client = new Anthropic({ apiKey: process.env['ANTHROPIC_API_KEY'], // This is the default and can be omitted }); const betaSelfHostedWork = await client.beta.environments.work.poll('env_011CZkZ9X2dpNyB7HsEFoRfW'); console.log(betaSelfHostedWork.id); ``` #### Response ```json { "id": "id", "acknowledged_at": "acknowledged_at", "created_at": "created_at", "data": { "id": "id", "type": "session" }, "environment_id": "environment_id", "latest_heartbeat_at": "latest_heartbeat_at", "metadata": { "foo": "string" }, "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } ``` ## Acknowledge Work `client.beta.environments.work.ack(stringworkID, WorkAckParamsparams, RequestOptionsoptions?): BetaSelfHostedWork` **post** `/v1/environments/{environment_id}/work/{work_id}/ack` Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly. Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' and removing it from the queue. ### Parameters - `workID: string` - `params: WorkAckParams` - `environment_id: string` Path param - `betas?: Array` Header param: Optional header to specify the beta version(s) you want to use. - `(string & {})` - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 23 more` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"thinking-token-count-2026-05-13"` ### Returns - `BetaSelfHostedWork` Work resource representing a unit of work in a self-hosted environment. Work items are queued when sessions are created or when long-dormant sessions receive new messages. The environment worker polls for work to execute in a self-hosted sandbox. - `id: string` Work identifier (e.g., 'work_...') - `acknowledged_at: string | null` RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox - `created_at: string` RFC 3339 timestamp when work was created - `data: BetaSessionWorkData` The actual work to be performed - `id: string` Session identifier (e.g., 'session_...') - `type: "session"` Type of work data - `"session"` - `environment_id: string` Environment identifier this work belongs to (e.g., `env_...`) - `latest_heartbeat_at: string | null` RFC 3339 timestamp of the most recent heartbeat - `metadata: Record` User-provided metadata key-value pairs associated with this work item - `started_at: string | null` RFC 3339 timestamp when work execution started - `state: "queued" | "starting" | "active" | 2 more` Current state of the work item - `"queued"` - `"starting"` - `"active"` - `"stopping"` - `"stopped"` - `stop_requested_at: string | null` RFC 3339 timestamp when stop was requested - `stopped_at: string | null` RFC 3339 timestamp when work execution stopped - `type: "work"` The type of object (always 'work') - `"work"` ### Example ```typescript import Anthropic from '@anthropic-ai/sdk'; const client = new Anthropic({ apiKey: process.env['ANTHROPIC_API_KEY'], // This is the default and can be omitted }); const betaSelfHostedWork = await client.beta.environments.work.ack('work_id', { environment_id: 'env_011CZkZ9X2dpNyB7HsEFoRfW', }); console.log(betaSelfHostedWork.id); ``` #### Response ```json { "id": "id", "acknowledged_at": "acknowledged_at", "created_at": "created_at", "data": { "id": "id", "type": "session" }, "environment_id": "environment_id", "latest_heartbeat_at": "latest_heartbeat_at", "metadata": { "foo": "string" }, "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } ``` ## Record Heartbeat `client.beta.environments.work.heartbeat(stringworkID, WorkHeartbeatParamsparams, RequestOptionsoptions?): BetaSelfHostedWorkHeartbeatResponse` **post** `/v1/environments/{environment_id}/work/{work_id}/heartbeat` Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly. Record a heartbeat for a work item to maintain the lease. ### Parameters - `workID: string` - `params: WorkHeartbeatParams` - `environment_id: string` Path param - `desired_ttl_seconds?: number | null` Query param: Desired TTL in seconds - `expected_last_heartbeat?: string | null` Query param: Expected last_heartbeat for conditional update (optimistic concurrency). Use literal 'NO_HEARTBEAT' to claim an unclaimed lease (first heartbeat). For subsequent heartbeats, echo the server's previous last_heartbeat value exactly. Returns 412 Precondition Failed if the actual value doesn't match. - `betas?: Array` Header param: Optional header to specify the beta version(s) you want to use. - `(string & {})` - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 23 more` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"thinking-token-count-2026-05-13"` ### Returns - `BetaSelfHostedWorkHeartbeatResponse` Response after recording a heartbeat for a work item. - `last_heartbeat: string` RFC 3339 timestamp of the actual heartbeat from DB - `lease_extended: boolean` Whether the heartbeat succeeded in extending the lease - `state: "queued" | "starting" | "active" | 2 more` Current state of the work item (active/stopping/stopped) - `"queued"` - `"starting"` - `"active"` - `"stopping"` - `"stopped"` - `ttl_seconds: number` Effective TTL applied to the lease - `type: "work_heartbeat"` The type of response - `"work_heartbeat"` ### Example ```typescript import Anthropic from '@anthropic-ai/sdk'; const client = new Anthropic({ apiKey: process.env['ANTHROPIC_API_KEY'], // This is the default and can be omitted }); const betaSelfHostedWorkHeartbeatResponse = await client.beta.environments.work.heartbeat( 'work_id', { environment_id: 'env_011CZkZ9X2dpNyB7HsEFoRfW' }, ); console.log(betaSelfHostedWorkHeartbeatResponse.last_heartbeat); ``` #### Response ```json { "last_heartbeat": "last_heartbeat", "lease_extended": true, "state": "queued", "ttl_seconds": 0, "type": "work_heartbeat" } ``` ## Stop Work `client.beta.environments.work.stop(stringworkID, WorkStopParamsparams, RequestOptionsoptions?): BetaSelfHostedWork` **post** `/v1/environments/{environment_id}/work/{work_id}/stop` Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly. Stop a work item, initiating graceful or forced shutdown. ### Parameters - `workID: string` - `params: WorkStopParams` - `environment_id: string` Path param - `force?: boolean` Body param: If true, immediately stop work without graceful shutdown - `betas?: Array` Header param: Optional header to specify the beta version(s) you want to use. - `(string & {})` - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 23 more` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"thinking-token-count-2026-05-13"` ### Returns - `BetaSelfHostedWork` Work resource representing a unit of work in a self-hosted environment. Work items are queued when sessions are created or when long-dormant sessions receive new messages. The environment worker polls for work to execute in a self-hosted sandbox. - `id: string` Work identifier (e.g., 'work_...') - `acknowledged_at: string | null` RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox - `created_at: string` RFC 3339 timestamp when work was created - `data: BetaSessionWorkData` The actual work to be performed - `id: string` Session identifier (e.g., 'session_...') - `type: "session"` Type of work data - `"session"` - `environment_id: string` Environment identifier this work belongs to (e.g., `env_...`) - `latest_heartbeat_at: string | null` RFC 3339 timestamp of the most recent heartbeat - `metadata: Record` User-provided metadata key-value pairs associated with this work item - `started_at: string | null` RFC 3339 timestamp when work execution started - `state: "queued" | "starting" | "active" | 2 more` Current state of the work item - `"queued"` - `"starting"` - `"active"` - `"stopping"` - `"stopped"` - `stop_requested_at: string | null` RFC 3339 timestamp when stop was requested - `stopped_at: string | null` RFC 3339 timestamp when work execution stopped - `type: "work"` The type of object (always 'work') - `"work"` ### Example ```typescript import Anthropic from '@anthropic-ai/sdk'; const client = new Anthropic({ apiKey: process.env['ANTHROPIC_API_KEY'], // This is the default and can be omitted }); const betaSelfHostedWork = await client.beta.environments.work.stop('work_id', { environment_id: 'env_011CZkZ9X2dpNyB7HsEFoRfW', }); console.log(betaSelfHostedWork.id); ``` #### Response ```json { "id": "id", "acknowledged_at": "acknowledged_at", "created_at": "created_at", "data": { "id": "id", "type": "session" }, "environment_id": "environment_id", "latest_heartbeat_at": "latest_heartbeat_at", "metadata": { "foo": "string" }, "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } ``` ## List Work Items `client.beta.environments.work.list(stringenvironmentID, WorkListParamsparams?, RequestOptionsoptions?): PageCursor` **get** `/v1/environments/{environment_id}/work` Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly. List work items in an environment. ### Parameters - `environmentID: string` - `params: WorkListParams` - `limit?: number` Query param: Maximum number of work items to return - `page?: string | null` Query param: Opaque cursor from previous response for pagination - `betas?: Array` Header param: Optional header to specify the beta version(s) you want to use. - `(string & {})` - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 23 more` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"thinking-token-count-2026-05-13"` ### Returns - `BetaSelfHostedWork` Work resource representing a unit of work in a self-hosted environment. Work items are queued when sessions are created or when long-dormant sessions receive new messages. The environment worker polls for work to execute in a self-hosted sandbox. - `id: string` Work identifier (e.g., 'work_...') - `acknowledged_at: string | null` RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox - `created_at: string` RFC 3339 timestamp when work was created - `data: BetaSessionWorkData` The actual work to be performed - `id: string` Session identifier (e.g., 'session_...') - `type: "session"` Type of work data - `"session"` - `environment_id: string` Environment identifier this work belongs to (e.g., `env_...`) - `latest_heartbeat_at: string | null` RFC 3339 timestamp of the most recent heartbeat - `metadata: Record` User-provided metadata key-value pairs associated with this work item - `started_at: string | null` RFC 3339 timestamp when work execution started - `state: "queued" | "starting" | "active" | 2 more` Current state of the work item - `"queued"` - `"starting"` - `"active"` - `"stopping"` - `"stopped"` - `stop_requested_at: string | null` RFC 3339 timestamp when stop was requested - `stopped_at: string | null` RFC 3339 timestamp when work execution stopped - `type: "work"` The type of object (always 'work') - `"work"` ### Example ```typescript import Anthropic from '@anthropic-ai/sdk'; const client = new Anthropic({ apiKey: process.env['ANTHROPIC_API_KEY'], // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const betaSelfHostedWork of client.beta.environments.work.list( 'env_011CZkZ9X2dpNyB7HsEFoRfW', )) { console.log(betaSelfHostedWork.id); } ``` #### Response ```json { "data": [ { "id": "id", "acknowledged_at": "acknowledged_at", "created_at": "created_at", "data": { "id": "id", "type": "session" }, "environment_id": "environment_id", "latest_heartbeat_at": "latest_heartbeat_at", "metadata": { "foo": "string" }, "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } ], "next_page": "next_page" } ``` ## Update Work Item `client.beta.environments.work.update(stringworkID, WorkUpdateParamsparams, RequestOptionsoptions?): BetaSelfHostedWork` **post** `/v1/environments/{environment_id}/work/{work_id}` Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly. Update work item metadata with merge semantics. ### Parameters - `workID: string` - `params: WorkUpdateParams` - `environment_id: string` Path param - `metadata: Record` Body param: Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve existing metadata. - `betas?: Array` Header param: Optional header to specify the beta version(s) you want to use. - `(string & {})` - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 23 more` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"thinking-token-count-2026-05-13"` ### Returns - `BetaSelfHostedWork` Work resource representing a unit of work in a self-hosted environment. Work items are queued when sessions are created or when long-dormant sessions receive new messages. The environment worker polls for work to execute in a self-hosted sandbox. - `id: string` Work identifier (e.g., 'work_...') - `acknowledged_at: string | null` RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox - `created_at: string` RFC 3339 timestamp when work was created - `data: BetaSessionWorkData` The actual work to be performed - `id: string` Session identifier (e.g., 'session_...') - `type: "session"` Type of work data - `"session"` - `environment_id: string` Environment identifier this work belongs to (e.g., `env_...`) - `latest_heartbeat_at: string | null` RFC 3339 timestamp of the most recent heartbeat - `metadata: Record` User-provided metadata key-value pairs associated with this work item - `started_at: string | null` RFC 3339 timestamp when work execution started - `state: "queued" | "starting" | "active" | 2 more` Current state of the work item - `"queued"` - `"starting"` - `"active"` - `"stopping"` - `"stopped"` - `stop_requested_at: string | null` RFC 3339 timestamp when stop was requested - `stopped_at: string | null` RFC 3339 timestamp when work execution stopped - `type: "work"` The type of object (always 'work') - `"work"` ### Example ```typescript import Anthropic from '@anthropic-ai/sdk'; const client = new Anthropic({ apiKey: process.env['ANTHROPIC_API_KEY'], // This is the default and can be omitted }); const betaSelfHostedWork = await client.beta.environments.work.update('work_id', { environment_id: 'env_011CZkZ9X2dpNyB7HsEFoRfW', metadata: { foo: 'string' }, }); console.log(betaSelfHostedWork.id); ``` #### Response ```json { "id": "id", "acknowledged_at": "acknowledged_at", "created_at": "created_at", "data": { "id": "id", "type": "session" }, "environment_id": "environment_id", "latest_heartbeat_at": "latest_heartbeat_at", "metadata": { "foo": "string" }, "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } ``` ## Get Queue Statistics `client.beta.environments.work.stats(stringenvironmentID, WorkStatsParamsparams?, RequestOptionsoptions?): BetaSelfHostedWorkQueueStats` **get** `/v1/environments/{environment_id}/work/stats` Get statistics about the work queue for an environment. ### Parameters - `environmentID: string` - `params: WorkStatsParams` - `betas?: Array` Optional header to specify the beta version(s) you want to use. - `(string & {})` - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 23 more` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"thinking-token-count-2026-05-13"` ### Returns - `BetaSelfHostedWorkQueueStats` Statistics about the work queue for an environment. Uses Redis Stream consumer group metrics for O(1) queries. - `depth: number` Number of work items waiting to be picked up (lag from consumer group) - `oldest_queued_at: string | null` RFC 3339 timestamp of oldest item in the work stream (includes both queued and pending items), null if stream empty - `pending: number` Number of work items being processed (polled but not acknowledged) - `type: "work_queue_stats"` The type of object - `"work_queue_stats"` - `workers_polling: number | null` Number of workers that have polled for work in the last 30 seconds. Requires worker_id to be sent with poll requests. ### Example ```typescript import Anthropic from '@anthropic-ai/sdk'; const client = new Anthropic({ apiKey: process.env['ANTHROPIC_API_KEY'], // This is the default and can be omitted }); const betaSelfHostedWorkQueueStats = await client.beta.environments.work.stats( 'env_011CZkZ9X2dpNyB7HsEFoRfW', ); console.log(betaSelfHostedWorkQueueStats.depth); ``` #### Response ```json { "depth": 0, "oldest_queued_at": "oldest_queued_at", "pending": 0, "type": "work_queue_stats", "workers_polling": 0 } ``` ## Domain Types ### Beta Self Hosted Work - `BetaSelfHostedWork` Work resource representing a unit of work in a self-hosted environment. Work items are queued when sessions are created or when long-dormant sessions receive new messages. The environment worker polls for work to execute in a self-hosted sandbox. - `id: string` Work identifier (e.g., 'work_...') - `acknowledged_at: string | null` RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox - `created_at: string` RFC 3339 timestamp when work was created - `data: BetaSessionWorkData` The actual work to be performed - `id: string` Session identifier (e.g., 'session_...') - `type: "session"` Type of work data - `"session"` - `environment_id: string` Environment identifier this work belongs to (e.g., `env_...`) - `latest_heartbeat_at: string | null` RFC 3339 timestamp of the most recent heartbeat - `metadata: Record` User-provided metadata key-value pairs associated with this work item - `started_at: string | null` RFC 3339 timestamp when work execution started - `state: "queued" | "starting" | "active" | 2 more` Current state of the work item - `"queued"` - `"starting"` - `"active"` - `"stopping"` - `"stopped"` - `stop_requested_at: string | null` RFC 3339 timestamp when stop was requested - `stopped_at: string | null` RFC 3339 timestamp when work execution stopped - `type: "work"` The type of object (always 'work') - `"work"` ### Beta Self Hosted Work Heartbeat Response - `BetaSelfHostedWorkHeartbeatResponse` Response after recording a heartbeat for a work item. - `last_heartbeat: string` RFC 3339 timestamp of the actual heartbeat from DB - `lease_extended: boolean` Whether the heartbeat succeeded in extending the lease - `state: "queued" | "starting" | "active" | 2 more` Current state of the work item (active/stopping/stopped) - `"queued"` - `"starting"` - `"active"` - `"stopping"` - `"stopped"` - `ttl_seconds: number` Effective TTL applied to the lease - `type: "work_heartbeat"` The type of response - `"work_heartbeat"` ### Beta Self Hosted Work List Response - `BetaSelfHostedWorkListResponse` Response when listing work items with cursor-based pagination. - `data: Array` List of work items - `id: string` Work identifier (e.g., 'work_...') - `acknowledged_at: string | null` RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox - `created_at: string` RFC 3339 timestamp when work was created - `data: BetaSessionWorkData` The actual work to be performed - `id: string` Session identifier (e.g., 'session_...') - `type: "session"` Type of work data - `"session"` - `environment_id: string` Environment identifier this work belongs to (e.g., `env_...`) - `latest_heartbeat_at: string | null` RFC 3339 timestamp of the most recent heartbeat - `metadata: Record` User-provided metadata key-value pairs associated with this work item - `started_at: string | null` RFC 3339 timestamp when work execution started - `state: "queued" | "starting" | "active" | 2 more` Current state of the work item - `"queued"` - `"starting"` - `"active"` - `"stopping"` - `"stopped"` - `stop_requested_at: string | null` RFC 3339 timestamp when stop was requested - `stopped_at: string | null` RFC 3339 timestamp when work execution stopped - `type: "work"` The type of object (always 'work') - `"work"` - `next_page: string | null` Opaque cursor for fetching the next page of results ### Beta Self Hosted Work Queue Stats - `BetaSelfHostedWorkQueueStats` Statistics about the work queue for an environment. Uses Redis Stream consumer group metrics for O(1) queries. - `depth: number` Number of work items waiting to be picked up (lag from consumer group) - `oldest_queued_at: string | null` RFC 3339 timestamp of oldest item in the work stream (includes both queued and pending items), null if stream empty - `pending: number` Number of work items being processed (polled but not acknowledged) - `type: "work_queue_stats"` The type of object - `"work_queue_stats"` - `workers_polling: number | null` Number of workers that have polled for work in the last 30 seconds. Requires worker_id to be sent with poll requests. ### Beta Self Hosted Work Stop Request - `BetaSelfHostedWorkStopRequest` Request to stop a work item. - `force?: boolean` If true, immediately stop work without graceful shutdown ### Beta Self Hosted Work Update Request - `BetaSelfHostedWorkUpdateRequest` Request to update work item metadata. - `metadata: Record` Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve existing metadata. ### Beta Session Work Data - `BetaSessionWorkData` Work data for session work items. This resource type is used when work represents a session that needs to be executed in a self-hosted environment. - `id: string` Session identifier (e.g., 'session_...') - `type: "session"` Type of work data - `"session"`