--- title: Environments url: https://platform.claude.com/docs/en/api/java/beta/environments --- # Environments ## Create Environment `BetaEnvironment beta().environments().create(params, requestOptions = RequestOptions.none())` **POST** `/v1/environments` Create a new environment with the specified configuration. ### Parameters - `EnvironmentCreateParams params` - `Optional> betas` (header parameter) Optional header to specify the beta version(s) you want to use. - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` - `PDFS_2024_09_25("pdfs-2024-09-25")` - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` - `FILES_API_2025_04_14("files-api-2025-04-14")` - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` - `SKILLS_2025_10_02("skills-2025-10-02")` - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` - `USER_PROFILES_2026_09_04("user-profiles-2026-09-04")` - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` - `DREAMING_2026_04_21("dreaming-2026-04-21")` - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `COMPACT_2026_01_12("compact-2026-01-12")` - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` - `MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")` - `THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")` - `MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `COMPACT_2026_09_04("compact-2026-09-04")` - `INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")` - `MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")` - `CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")` - `SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")` - `TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")` - `Optional workspaceId` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. - `String name` Human-readable name for the environment minLength: 1, maxLength: 256 - `Optional config` Environment configuration - `class BetaCloudConfigParams` Request params for `cloud` environment configuration. Fields default to null; on update, omitted fields preserve the existing value. - `JsonValue type = "cloud"` Environment type - `Optional networking` Network configuration policy. Omit on update to preserve the existing value. - `class BetaUnrestrictedNetwork` Unrestricted network access. - `JsonValue type = "unrestricted"` Network policy type - `class BetaLimitedNetworkParams` Limited network request params. Fields default to null; on update, omitted fields preserve the existing value. - `JsonValue type = "limited"` Network policy type - `Optional allowMcpServers` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. Defaults to `false`. - `Optional allowPackageManagers` 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. - `Optional> allowedHosts` Specifies domains the container can reach. - `Optional packages` Package manager configuration. Under `limited` networking, requires `networking.allow_package_managers` to be `true`. Omit on update to preserve the existing value. - `Optional type` Package configuration type - `Optional> apt` Ubuntu/Debian packages to install - `Optional> cargo` Rust packages to install - `Optional> gem` Ruby packages to install - `Optional> go` Go packages to install - `Optional> npm` Node.js packages to install - `Optional> pip` Python packages to install - `class BetaSelfHostedConfigParams` Request params for `self_hosted` environment configuration. - `JsonValue type = "self_hosted"` Environment type - `Optional description` Optional description of the environment maxLength: 1024 - `Optional metadata` User-provided metadata key-value pairs - `Optional scope` The visibility scope for this environment. 'organization' makes the environment visible to all accounts. 'account' restricts visibility to the owning account only. API organizations support only 'organization'; 'account' is rejected. If not specified, defaults based on organization type. - `ORGANIZATION("organization")` - `ACCOUNT("account")` ### Returns - `class BetaEnvironment` Unified Environment resource for both cloud and self-hosted environments. - `JsonValue type = "environment"` The type of object (always 'environment') - `String id` Environment identifier (e.g., 'env_...') - `Optional archivedAt` RFC 3339 timestamp when environment was archived, or null if not archived - `Config config` Environment configuration (either Anthropic Cloud or self-hosted) - `class BetaCloudConfig` `cloud` environment configuration. - `JsonValue type = "cloud"` Environment type - `Networking networking` Network configuration policy. - `class BetaUnrestrictedNetwork` Unrestricted network access. - `JsonValue type = "unrestricted"` Network policy type - `class BetaLimitedNetwork` Limited network access. - `JsonValue type = "limited"` Network policy type - `boolean allowMcpServers` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. - `boolean allowPackageManagers` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. - `List allowedHosts` Specifies domains the container can reach. - `BetaPackages packages` Package manager configuration. - `Optional type` Package configuration type - `List apt` Ubuntu/Debian packages to install - `List cargo` Rust packages to install - `List gem` Ruby packages to install - `List go` Go packages to install - `List npm` Node.js packages to install - `List pip` Python packages to install - `class BetaSelfHostedConfig` Configuration for self-hosted environments. - `JsonValue type = "self_hosted"` Environment type - `String createdAt` RFC 3339 timestamp when environment was created - `Optional description` User-provided description for the environment; null when unset - `Metadata metadata` User-provided metadata key-value pairs - `String name` Human-readable name for the environment - `String updatedAt` RFC 3339 timestamp when environment was last updated - `Optional scope` The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account. - `ORGANIZATION("organization")` - `ACCOUNT("account")` ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.environments.BetaEnvironment; import com.anthropic.models.beta.environments.EnvironmentCreateParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); EnvironmentCreateParams params = EnvironmentCreateParams.builder() .name("python-data-analysis") .build(); BetaEnvironment betaEnvironment = client.beta().environments().create(params); } } ``` #### Response (200) ```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 `EnvironmentListPage beta().environments().list(params = EnvironmentListParams.none(), requestOptions = RequestOptions.none())` **GET** `/v1/environments` List environments with pagination support. ### Parameters - `EnvironmentListParams params` - `Optional includeArchived` (query parameter) Include archived environments in the response - `Optional limit` (query parameter) Maximum number of environments to return minimum: 1, maximum: 1000 - `Optional page` (query parameter) Opaque cursor from previous response for pagination. Pass the `next_page` value from the previous response. - `Optional> betas` (header parameter) Optional header to specify the beta version(s) you want to use. - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` - `PDFS_2024_09_25("pdfs-2024-09-25")` - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` - `FILES_API_2025_04_14("files-api-2025-04-14")` - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` - `SKILLS_2025_10_02("skills-2025-10-02")` - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` - `USER_PROFILES_2026_09_04("user-profiles-2026-09-04")` - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` - `DREAMING_2026_04_21("dreaming-2026-04-21")` - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `COMPACT_2026_01_12("compact-2026-01-12")` - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` - `MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")` - `THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")` - `MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `COMPACT_2026_09_04("compact-2026-09-04")` - `INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")` - `MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")` - `CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")` - `SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")` - `TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")` - `Optional workspaceId` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. ### Returns - `class BetaEnvironment` Unified Environment resource for both cloud and self-hosted environments. - `JsonValue type = "environment"` The type of object (always 'environment') - `String id` Environment identifier (e.g., 'env_...') - `Optional archivedAt` RFC 3339 timestamp when environment was archived, or null if not archived - `Config config` Environment configuration (either Anthropic Cloud or self-hosted) - `class BetaCloudConfig` `cloud` environment configuration. - `JsonValue type = "cloud"` Environment type - `Networking networking` Network configuration policy. - `class BetaUnrestrictedNetwork` Unrestricted network access. - `JsonValue type = "unrestricted"` Network policy type - `class BetaLimitedNetwork` Limited network access. - `JsonValue type = "limited"` Network policy type - `boolean allowMcpServers` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. - `boolean allowPackageManagers` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. - `List allowedHosts` Specifies domains the container can reach. - `BetaPackages packages` Package manager configuration. - `Optional type` Package configuration type - `List apt` Ubuntu/Debian packages to install - `List cargo` Rust packages to install - `List gem` Ruby packages to install - `List go` Go packages to install - `List npm` Node.js packages to install - `List pip` Python packages to install - `class BetaSelfHostedConfig` Configuration for self-hosted environments. - `JsonValue type = "self_hosted"` Environment type - `String createdAt` RFC 3339 timestamp when environment was created - `Optional description` User-provided description for the environment; null when unset - `Metadata metadata` User-provided metadata key-value pairs - `String name` Human-readable name for the environment - `String updatedAt` RFC 3339 timestamp when environment was last updated - `Optional scope` The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account. - `ORGANIZATION("organization")` - `ACCOUNT("account")` ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.environments.EnvironmentListPage; import com.anthropic.models.beta.environments.EnvironmentListParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); EnvironmentListPage page = client.beta().environments().list(); } } ``` #### Response (200) ```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 `BetaEnvironment beta().environments().retrieve(params = EnvironmentRetrieveParams.none(), requestOptions = RequestOptions.none())` **GET** `/v1/environments/{environment_id}` Retrieve a specific environment by ID. ### Parameters - `EnvironmentRetrieveParams params` - `Optional environmentId` (path parameter) - `Optional> betas` (header parameter) Optional header to specify the beta version(s) you want to use. - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` - `PDFS_2024_09_25("pdfs-2024-09-25")` - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` - `FILES_API_2025_04_14("files-api-2025-04-14")` - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` - `SKILLS_2025_10_02("skills-2025-10-02")` - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` - `USER_PROFILES_2026_09_04("user-profiles-2026-09-04")` - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` - `DREAMING_2026_04_21("dreaming-2026-04-21")` - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `COMPACT_2026_01_12("compact-2026-01-12")` - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` - `MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")` - `THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")` - `MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `COMPACT_2026_09_04("compact-2026-09-04")` - `INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")` - `MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")` - `CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")` - `SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")` - `TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")` - `Optional workspaceId` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. ### Returns - `class BetaEnvironment` Unified Environment resource for both cloud and self-hosted environments. - `JsonValue type = "environment"` The type of object (always 'environment') - `String id` Environment identifier (e.g., 'env_...') - `Optional archivedAt` RFC 3339 timestamp when environment was archived, or null if not archived - `Config config` Environment configuration (either Anthropic Cloud or self-hosted) - `class BetaCloudConfig` `cloud` environment configuration. - `JsonValue type = "cloud"` Environment type - `Networking networking` Network configuration policy. - `class BetaUnrestrictedNetwork` Unrestricted network access. - `JsonValue type = "unrestricted"` Network policy type - `class BetaLimitedNetwork` Limited network access. - `JsonValue type = "limited"` Network policy type - `boolean allowMcpServers` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. - `boolean allowPackageManagers` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. - `List allowedHosts` Specifies domains the container can reach. - `BetaPackages packages` Package manager configuration. - `Optional type` Package configuration type - `List apt` Ubuntu/Debian packages to install - `List cargo` Rust packages to install - `List gem` Ruby packages to install - `List go` Go packages to install - `List npm` Node.js packages to install - `List pip` Python packages to install - `class BetaSelfHostedConfig` Configuration for self-hosted environments. - `JsonValue type = "self_hosted"` Environment type - `String createdAt` RFC 3339 timestamp when environment was created - `Optional description` User-provided description for the environment; null when unset - `Metadata metadata` User-provided metadata key-value pairs - `String name` Human-readable name for the environment - `String updatedAt` RFC 3339 timestamp when environment was last updated - `Optional scope` The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account. - `ORGANIZATION("organization")` - `ACCOUNT("account")` ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.environments.BetaEnvironment; import com.anthropic.models.beta.environments.EnvironmentRetrieveParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); BetaEnvironment betaEnvironment = client.beta().environments().retrieve("env_011CZkZ9X2dpNyB7HsEFoRfW"); } } ``` #### Response (200) ```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 `BetaEnvironment beta().environments().update(params = EnvironmentUpdateParams.none(), requestOptions = RequestOptions.none())` **POST** `/v1/environments/{environment_id}` Update an existing environment's configuration. ### Parameters - `EnvironmentUpdateParams params` - `Optional environmentId` (path parameter) - `Optional> betas` (header parameter) Optional header to specify the beta version(s) you want to use. - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` - `PDFS_2024_09_25("pdfs-2024-09-25")` - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` - `FILES_API_2025_04_14("files-api-2025-04-14")` - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` - `SKILLS_2025_10_02("skills-2025-10-02")` - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` - `USER_PROFILES_2026_09_04("user-profiles-2026-09-04")` - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` - `DREAMING_2026_04_21("dreaming-2026-04-21")` - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `COMPACT_2026_01_12("compact-2026-01-12")` - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` - `MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")` - `THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")` - `MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `COMPACT_2026_09_04("compact-2026-09-04")` - `INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")` - `MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")` - `CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")` - `SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")` - `TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")` - `Optional workspaceId` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. - `Optional config` Updated environment configuration - `class BetaCloudConfigParams` Request params for `cloud` environment configuration. Fields default to null; on update, omitted fields preserve the existing value. - `JsonValue type = "cloud"` Environment type - `Optional networking` Network configuration policy. Omit on update to preserve the existing value. - `class BetaUnrestrictedNetwork` Unrestricted network access. - `JsonValue type = "unrestricted"` Network policy type - `class BetaLimitedNetworkParams` Limited network request params. Fields default to null; on update, omitted fields preserve the existing value. - `JsonValue type = "limited"` Network policy type - `Optional allowMcpServers` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. Defaults to `false`. - `Optional allowPackageManagers` 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. - `Optional> allowedHosts` Specifies domains the container can reach. - `Optional packages` Package manager configuration. Under `limited` networking, requires `networking.allow_package_managers` to be `true`. Omit on update to preserve the existing value. - `Optional type` Package configuration type - `Optional> apt` Ubuntu/Debian packages to install - `Optional> cargo` Rust packages to install - `Optional> gem` Ruby packages to install - `Optional> go` Go packages to install - `Optional> npm` Node.js packages to install - `Optional> pip` Python packages to install - `class BetaSelfHostedConfigParams` Request params for `self_hosted` environment configuration. - `JsonValue type = "self_hosted"` Environment type - `Optional description` Updated description of the environment. Omit to preserve; null clears to null; an empty string is stored as an empty string. maxLength: 1024 - `Optional metadata` User-provided metadata key-value pairs. Set a value to null or empty string to delete the key. - `Optional name` Updated name for the environment minLength: 1, maxLength: 256 - `Optional scope` The visibility scope for this environment. 'organization' makes the environment visible to all accounts. 'account' restricts visibility to the owning account only. - `ORGANIZATION("organization")` - `ACCOUNT("account")` ### Returns - `class BetaEnvironment` Unified Environment resource for both cloud and self-hosted environments. - `JsonValue type = "environment"` The type of object (always 'environment') - `String id` Environment identifier (e.g., 'env_...') - `Optional archivedAt` RFC 3339 timestamp when environment was archived, or null if not archived - `Config config` Environment configuration (either Anthropic Cloud or self-hosted) - `class BetaCloudConfig` `cloud` environment configuration. - `JsonValue type = "cloud"` Environment type - `Networking networking` Network configuration policy. - `class BetaUnrestrictedNetwork` Unrestricted network access. - `JsonValue type = "unrestricted"` Network policy type - `class BetaLimitedNetwork` Limited network access. - `JsonValue type = "limited"` Network policy type - `boolean allowMcpServers` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. - `boolean allowPackageManagers` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. - `List allowedHosts` Specifies domains the container can reach. - `BetaPackages packages` Package manager configuration. - `Optional type` Package configuration type - `List apt` Ubuntu/Debian packages to install - `List cargo` Rust packages to install - `List gem` Ruby packages to install - `List go` Go packages to install - `List npm` Node.js packages to install - `List pip` Python packages to install - `class BetaSelfHostedConfig` Configuration for self-hosted environments. - `JsonValue type = "self_hosted"` Environment type - `String createdAt` RFC 3339 timestamp when environment was created - `Optional description` User-provided description for the environment; null when unset - `Metadata metadata` User-provided metadata key-value pairs - `String name` Human-readable name for the environment - `String updatedAt` RFC 3339 timestamp when environment was last updated - `Optional scope` The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account. - `ORGANIZATION("organization")` - `ACCOUNT("account")` ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.environments.BetaEnvironment; import com.anthropic.models.beta.environments.EnvironmentUpdateParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); BetaEnvironment betaEnvironment = client.beta().environments().update("env_011CZkZ9X2dpNyB7HsEFoRfW"); } } ``` #### Response (200) ```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 `BetaEnvironmentDeleteResponse beta().environments().delete(params = EnvironmentDeleteParams.none(), requestOptions = RequestOptions.none())` **DELETE** `/v1/environments/{environment_id}` Delete an environment by ID. Returns a confirmation of the deletion. ### Parameters - `EnvironmentDeleteParams params` - `Optional environmentId` (path parameter) - `Optional> betas` (header parameter) Optional header to specify the beta version(s) you want to use. - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` - `PDFS_2024_09_25("pdfs-2024-09-25")` - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` - `FILES_API_2025_04_14("files-api-2025-04-14")` - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` - `SKILLS_2025_10_02("skills-2025-10-02")` - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` - `USER_PROFILES_2026_09_04("user-profiles-2026-09-04")` - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` - `DREAMING_2026_04_21("dreaming-2026-04-21")` - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `COMPACT_2026_01_12("compact-2026-01-12")` - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` - `MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")` - `THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")` - `MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `COMPACT_2026_09_04("compact-2026-09-04")` - `INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")` - `MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")` - `CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")` - `SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")` - `TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")` - `Optional workspaceId` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. ### Returns - `class BetaEnvironmentDeleteResponse` Response after deleting an environment. - `Type type` The type of response - `String id` Environment identifier ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.environments.BetaEnvironmentDeleteResponse; import com.anthropic.models.beta.environments.EnvironmentDeleteParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); BetaEnvironmentDeleteResponse betaEnvironmentDeleteResponse = client.beta().environments().delete("env_011CZkZ9X2dpNyB7HsEFoRfW"); } } ``` #### Response (200) ```json { "id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "type": "environment_deleted" } ``` ## Archive Environment `BetaEnvironment beta().environments().archive(params = EnvironmentArchiveParams.none(), requestOptions = RequestOptions.none())` **POST** `/v1/environments/{environment_id}/archive` Archive an environment by ID. Archived environments cannot be used to create new sessions. ### Parameters - `EnvironmentArchiveParams params` - `Optional environmentId` (path parameter) - `Optional> betas` (header parameter) Optional header to specify the beta version(s) you want to use. - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` - `PDFS_2024_09_25("pdfs-2024-09-25")` - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` - `FILES_API_2025_04_14("files-api-2025-04-14")` - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` - `SKILLS_2025_10_02("skills-2025-10-02")` - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` - `USER_PROFILES_2026_09_04("user-profiles-2026-09-04")` - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` - `DREAMING_2026_04_21("dreaming-2026-04-21")` - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `COMPACT_2026_01_12("compact-2026-01-12")` - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` - `MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")` - `THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")` - `MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `COMPACT_2026_09_04("compact-2026-09-04")` - `INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")` - `MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")` - `CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")` - `SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")` - `TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")` - `Optional workspaceId` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. ### Returns - `class BetaEnvironment` Unified Environment resource for both cloud and self-hosted environments. - `JsonValue type = "environment"` The type of object (always 'environment') - `String id` Environment identifier (e.g., 'env_...') - `Optional archivedAt` RFC 3339 timestamp when environment was archived, or null if not archived - `Config config` Environment configuration (either Anthropic Cloud or self-hosted) - `class BetaCloudConfig` `cloud` environment configuration. - `JsonValue type = "cloud"` Environment type - `Networking networking` Network configuration policy. - `class BetaUnrestrictedNetwork` Unrestricted network access. - `JsonValue type = "unrestricted"` Network policy type - `class BetaLimitedNetwork` Limited network access. - `JsonValue type = "limited"` Network policy type - `boolean allowMcpServers` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. - `boolean allowPackageManagers` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. - `List allowedHosts` Specifies domains the container can reach. - `BetaPackages packages` Package manager configuration. - `Optional type` Package configuration type - `List apt` Ubuntu/Debian packages to install - `List cargo` Rust packages to install - `List gem` Ruby packages to install - `List go` Go packages to install - `List npm` Node.js packages to install - `List pip` Python packages to install - `class BetaSelfHostedConfig` Configuration for self-hosted environments. - `JsonValue type = "self_hosted"` Environment type - `String createdAt` RFC 3339 timestamp when environment was created - `Optional description` User-provided description for the environment; null when unset - `Metadata metadata` User-provided metadata key-value pairs - `String name` Human-readable name for the environment - `String updatedAt` RFC 3339 timestamp when environment was last updated - `Optional scope` The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account. - `ORGANIZATION("organization")` - `ACCOUNT("account")` ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.environments.BetaEnvironment; import com.anthropic.models.beta.environments.EnvironmentArchiveParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); BetaEnvironment betaEnvironment = client.beta().environments().archive("env_011CZkZ9X2dpNyB7HsEFoRfW"); } } ``` #### Response (200) ```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 - `class BetaCloudConfig` `cloud` environment configuration. - `JsonValue type = "cloud"` Environment type - `Networking networking` Network configuration policy. - `class BetaUnrestrictedNetwork` Unrestricted network access. - `JsonValue type = "unrestricted"` Network policy type - `class BetaLimitedNetwork` Limited network access. - `JsonValue type = "limited"` Network policy type - `boolean allowMcpServers` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. - `boolean allowPackageManagers` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. - `List allowedHosts` Specifies domains the container can reach. - `BetaPackages packages` Package manager configuration. - `Optional type` Package configuration type - `List apt` Ubuntu/Debian packages to install - `List cargo` Rust packages to install - `List gem` Ruby packages to install - `List go` Go packages to install - `List npm` Node.js packages to install - `List pip` Python packages to install ### Beta Cloud Config Params - `class BetaCloudConfigParams` Request params for `cloud` environment configuration. Fields default to null; on update, omitted fields preserve the existing value. - `JsonValue type = "cloud"` Environment type - `Optional networking` Network configuration policy. Omit on update to preserve the existing value. - `class BetaUnrestrictedNetwork` Unrestricted network access. - `JsonValue type = "unrestricted"` Network policy type - `class BetaLimitedNetworkParams` Limited network request params. Fields default to null; on update, omitted fields preserve the existing value. - `JsonValue type = "limited"` Network policy type - `Optional allowMcpServers` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. Defaults to `false`. - `Optional allowPackageManagers` 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. - `Optional> allowedHosts` Specifies domains the container can reach. - `Optional packages` Package manager configuration. Under `limited` networking, requires `networking.allow_package_managers` to be `true`. Omit on update to preserve the existing value. - `Optional type` Package configuration type - `Optional> apt` Ubuntu/Debian packages to install - `Optional> cargo` Rust packages to install - `Optional> gem` Ruby packages to install - `Optional> go` Go packages to install - `Optional> npm` Node.js packages to install - `Optional> pip` Python packages to install ### Beta Environment - `class BetaEnvironment` Unified Environment resource for both cloud and self-hosted environments. - `JsonValue type = "environment"` The type of object (always 'environment') - `String id` Environment identifier (e.g., 'env_...') - `Optional archivedAt` RFC 3339 timestamp when environment was archived, or null if not archived - `Config config` Environment configuration (either Anthropic Cloud or self-hosted) - `class BetaCloudConfig` `cloud` environment configuration. - `JsonValue type = "cloud"` Environment type - `Networking networking` Network configuration policy. - `class BetaUnrestrictedNetwork` Unrestricted network access. - `JsonValue type = "unrestricted"` Network policy type - `class BetaLimitedNetwork` Limited network access. - `JsonValue type = "limited"` Network policy type - `boolean allowMcpServers` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. - `boolean allowPackageManagers` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. - `List allowedHosts` Specifies domains the container can reach. - `BetaPackages packages` Package manager configuration. - `Optional type` Package configuration type - `List apt` Ubuntu/Debian packages to install - `List cargo` Rust packages to install - `List gem` Ruby packages to install - `List go` Go packages to install - `List npm` Node.js packages to install - `List pip` Python packages to install - `class BetaSelfHostedConfig` Configuration for self-hosted environments. - `JsonValue type = "self_hosted"` Environment type - `String createdAt` RFC 3339 timestamp when environment was created - `Optional description` User-provided description for the environment; null when unset - `Metadata metadata` User-provided metadata key-value pairs - `String name` Human-readable name for the environment - `String updatedAt` RFC 3339 timestamp when environment was last updated - `Optional scope` The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account. - `ORGANIZATION("organization")` - `ACCOUNT("account")` ### Beta Environment Delete Response - `class BetaEnvironmentDeleteResponse` Response after deleting an environment. - `Type type` The type of response - `String id` Environment identifier ### Beta Limited Network - `class BetaLimitedNetwork` Limited network access. - `JsonValue type = "limited"` Network policy type - `boolean allowMcpServers` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. - `boolean allowPackageManagers` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. - `List allowedHosts` Specifies domains the container can reach. ### Beta Limited Network Params - `class BetaLimitedNetworkParams` Limited network request params. Fields default to null; on update, omitted fields preserve the existing value. - `JsonValue type = "limited"` Network policy type - `Optional allowMcpServers` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. Defaults to `false`. - `Optional allowPackageManagers` 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. - `Optional> allowedHosts` Specifies domains the container can reach. ### Beta Packages - `class BetaPackages` Packages (and their versions) available in this environment. - `Optional type` Package configuration type - `List apt` Ubuntu/Debian packages to install - `List cargo` Rust packages to install - `List gem` Ruby packages to install - `List go` Go packages to install - `List npm` Node.js packages to install - `List pip` Python packages to install ### Beta Packages Params - `class 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. Under `limited` networking, requires `networking.allow_package_managers` to be `true`. - `Optional type` Package configuration type - `Optional> apt` Ubuntu/Debian packages to install - `Optional> cargo` Rust packages to install - `Optional> gem` Ruby packages to install - `Optional> go` Go packages to install - `Optional> npm` Node.js packages to install - `Optional> pip` Python packages to install ### Beta Self Hosted Config - `class BetaSelfHostedConfig` Configuration for self-hosted environments. - `JsonValue type = "self_hosted"` Environment type ### Beta Self Hosted Config Params - `class BetaSelfHostedConfigParams` Request params for `self_hosted` environment configuration. - `JsonValue type = "self_hosted"` Environment type ### Beta Unrestricted Network - `class BetaUnrestrictedNetwork` Unrestricted network access. - `JsonValue type = "unrestricted"` Network policy type ## Environments › Work ### Get Work Item `BetaSelfHostedWork beta().environments().work().retrieve(params, requestOptions = RequestOptions.none())` **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 - `WorkRetrieveParams params` - `String environmentId` (path parameter) - `Optional workId` (path parameter) - `Optional> betas` (header parameter) Optional header to specify the beta version(s) you want to use. - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` - `PDFS_2024_09_25("pdfs-2024-09-25")` - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` - `FILES_API_2025_04_14("files-api-2025-04-14")` - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` - `SKILLS_2025_10_02("skills-2025-10-02")` - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` - `USER_PROFILES_2026_09_04("user-profiles-2026-09-04")` - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` - `DREAMING_2026_04_21("dreaming-2026-04-21")` - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `COMPACT_2026_01_12("compact-2026-01-12")` - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` - `MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")` - `THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")` - `MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `COMPACT_2026_09_04("compact-2026-09-04")` - `INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")` - `MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")` - `CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")` - `SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")` - `TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")` - `Optional workspaceId` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `class 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. - `JsonValue type = "work"` The type of object (always 'work') - `String id` Work identifier (e.g., 'work_...') - `Optional acknowledgedAt` RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox - `String createdAt` RFC 3339 timestamp when work was created - `BetaSessionWorkData data` The actual work to be performed - `JsonValue type = "session"` Type of work data - `String id` Session identifier (e.g., 'session_...') - `String environmentId` Environment identifier this work belongs to (e.g., `env_...`) - `Optional latestHeartbeatAt` RFC 3339 timestamp of the most recent heartbeat - `Metadata metadata` User-provided metadata key-value pairs associated with this work item - `Optional secret` Credential payload used by the environment worker to execute this work item. May be populated when polling for work; null on all other retrieval paths. - `Optional startedAt` RFC 3339 timestamp when work execution started - `State state` Current state of the work item - `QUEUED("queued")` - `STARTING("starting")` - `ACTIVE("active")` - `STOPPING("stopping")` - `STOPPED("stopped")` - `Optional stopRequestedAt` RFC 3339 timestamp when stop was requested - `Optional stoppedAt` RFC 3339 timestamp when work execution stopped #### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.environments.work.BetaSelfHostedWork; import com.anthropic.models.beta.environments.work.WorkRetrieveParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); WorkRetrieveParams params = WorkRetrieveParams.builder() .environmentId("env_011CZkZ9X2dpNyB7HsEFoRfW") .workId("work_id") .build(); BetaSelfHostedWork betaSelfHostedWork = client.beta().environments().work().retrieve(params); } } ``` ##### Response (200) ```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" }, "secret": "secret", "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } ``` ### Poll for Work `BetaSelfHostedWork beta().environments().work().poll(params = WorkPollParams.none(), requestOptions = RequestOptions.none())` **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 - `WorkPollParams params` - `Optional environmentId` (path parameter) - `Optional blockMs` (query parameter) 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). minimum: 1 - `Optional reclaimOlderThanMs` (query parameter) Reclaim unacknowledged work items older than this many milliseconds. If omitted, uses the default (5000ms). minimum: 1 - `Optional> betas` (header parameter) Optional header to specify the beta version(s) you want to use. - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` - `PDFS_2024_09_25("pdfs-2024-09-25")` - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` - `FILES_API_2025_04_14("files-api-2025-04-14")` - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` - `SKILLS_2025_10_02("skills-2025-10-02")` - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` - `USER_PROFILES_2026_09_04("user-profiles-2026-09-04")` - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` - `DREAMING_2026_04_21("dreaming-2026-04-21")` - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `COMPACT_2026_01_12("compact-2026-01-12")` - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` - `MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")` - `THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")` - `MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `COMPACT_2026_09_04("compact-2026-09-04")` - `INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")` - `MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")` - `CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")` - `SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")` - `TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")` - `Optional anthropicWorkerId` (header parameter) Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console #### Returns - `class 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. - `JsonValue type = "work"` The type of object (always 'work') - `String id` Work identifier (e.g., 'work_...') - `Optional acknowledgedAt` RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox - `String createdAt` RFC 3339 timestamp when work was created - `BetaSessionWorkData data` The actual work to be performed - `JsonValue type = "session"` Type of work data - `String id` Session identifier (e.g., 'session_...') - `String environmentId` Environment identifier this work belongs to (e.g., `env_...`) - `Optional latestHeartbeatAt` RFC 3339 timestamp of the most recent heartbeat - `Metadata metadata` User-provided metadata key-value pairs associated with this work item - `Optional secret` Credential payload used by the environment worker to execute this work item. May be populated when polling for work; null on all other retrieval paths. - `Optional startedAt` RFC 3339 timestamp when work execution started - `State state` Current state of the work item - `QUEUED("queued")` - `STARTING("starting")` - `ACTIVE("active")` - `STOPPING("stopping")` - `STOPPED("stopped")` - `Optional stopRequestedAt` RFC 3339 timestamp when stop was requested - `Optional stoppedAt` RFC 3339 timestamp when work execution stopped #### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.environments.work.BetaSelfHostedWork; import com.anthropic.models.beta.environments.work.WorkPollParams; import java.util.Optional; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); Optional betaSelfHostedWork = client.beta().environments().work().poll("env_011CZkZ9X2dpNyB7HsEFoRfW"); } } ``` ##### Response (200) ```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" }, "secret": "secret", "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } ``` ### Acknowledge Work `BetaSelfHostedWork beta().environments().work().ack(params, requestOptions = RequestOptions.none())` **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 - `WorkAckParams params` - `String environmentId` (path parameter) - `Optional workId` (path parameter) - `Optional> betas` (header parameter) Optional header to specify the beta version(s) you want to use. - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` - `PDFS_2024_09_25("pdfs-2024-09-25")` - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` - `FILES_API_2025_04_14("files-api-2025-04-14")` - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` - `SKILLS_2025_10_02("skills-2025-10-02")` - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` - `USER_PROFILES_2026_09_04("user-profiles-2026-09-04")` - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` - `DREAMING_2026_04_21("dreaming-2026-04-21")` - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `COMPACT_2026_01_12("compact-2026-01-12")` - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` - `MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")` - `THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")` - `MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `COMPACT_2026_09_04("compact-2026-09-04")` - `INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")` - `MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")` - `CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")` - `SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")` - `TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")` #### Returns - `class 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. - `JsonValue type = "work"` The type of object (always 'work') - `String id` Work identifier (e.g., 'work_...') - `Optional acknowledgedAt` RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox - `String createdAt` RFC 3339 timestamp when work was created - `BetaSessionWorkData data` The actual work to be performed - `JsonValue type = "session"` Type of work data - `String id` Session identifier (e.g., 'session_...') - `String environmentId` Environment identifier this work belongs to (e.g., `env_...`) - `Optional latestHeartbeatAt` RFC 3339 timestamp of the most recent heartbeat - `Metadata metadata` User-provided metadata key-value pairs associated with this work item - `Optional secret` Credential payload used by the environment worker to execute this work item. May be populated when polling for work; null on all other retrieval paths. - `Optional startedAt` RFC 3339 timestamp when work execution started - `State state` Current state of the work item - `QUEUED("queued")` - `STARTING("starting")` - `ACTIVE("active")` - `STOPPING("stopping")` - `STOPPED("stopped")` - `Optional stopRequestedAt` RFC 3339 timestamp when stop was requested - `Optional stoppedAt` RFC 3339 timestamp when work execution stopped #### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.environments.work.BetaSelfHostedWork; import com.anthropic.models.beta.environments.work.WorkAckParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); WorkAckParams params = WorkAckParams.builder() .environmentId("env_011CZkZ9X2dpNyB7HsEFoRfW") .workId("work_id") .build(); BetaSelfHostedWork betaSelfHostedWork = client.beta().environments().work().ack(params); } } ``` ##### Response (200) ```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" }, "secret": "secret", "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } ``` ### Record Heartbeat `BetaSelfHostedWorkHeartbeatResponse beta().environments().work().heartbeat(params, requestOptions = RequestOptions.none())` **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 - `WorkHeartbeatParams params` - `String environmentId` (path parameter) - `Optional workId` (path parameter) - `Optional desiredTtlSeconds` (query parameter) Desired TTL in seconds - `Optional expectedLastHeartbeat` (query parameter) 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. - `Optional> betas` (header parameter) Optional header to specify the beta version(s) you want to use. - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` - `PDFS_2024_09_25("pdfs-2024-09-25")` - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` - `FILES_API_2025_04_14("files-api-2025-04-14")` - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` - `SKILLS_2025_10_02("skills-2025-10-02")` - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` - `USER_PROFILES_2026_09_04("user-profiles-2026-09-04")` - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` - `DREAMING_2026_04_21("dreaming-2026-04-21")` - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `COMPACT_2026_01_12("compact-2026-01-12")` - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` - `MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")` - `THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")` - `MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `COMPACT_2026_09_04("compact-2026-09-04")` - `INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")` - `MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")` - `CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")` - `SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")` - `TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")` #### Returns - `class BetaSelfHostedWorkHeartbeatResponse` Response after recording a heartbeat for a work item. - `JsonValue type = "work_heartbeat"` The type of response - `String lastHeartbeat` RFC 3339 timestamp of the actual heartbeat from DB - `boolean leaseExtended` Whether the heartbeat succeeded in extending the lease - `State state` Current state of the work item (active/stopping/stopped) - `QUEUED("queued")` - `STARTING("starting")` - `ACTIVE("active")` - `STOPPING("stopping")` - `STOPPED("stopped")` - `long ttlSeconds` Effective TTL applied to the lease #### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.environments.work.BetaSelfHostedWorkHeartbeatResponse; import com.anthropic.models.beta.environments.work.WorkHeartbeatParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); WorkHeartbeatParams params = WorkHeartbeatParams.builder() .environmentId("env_011CZkZ9X2dpNyB7HsEFoRfW") .workId("work_id") .build(); BetaSelfHostedWorkHeartbeatResponse betaSelfHostedWorkHeartbeatResponse = client.beta().environments().work().heartbeat(params); } } ``` ##### Response (200) ```json { "last_heartbeat": "last_heartbeat", "lease_extended": true, "state": "queued", "ttl_seconds": 0, "type": "work_heartbeat" } ``` ### Stop Work `BetaSelfHostedWork beta().environments().work().stop(params, requestOptions = RequestOptions.none())` **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 - `WorkStopParams params` - `String environmentId` (path parameter) - `Optional workId` (path parameter) - `Optional> betas` (header parameter) Optional header to specify the beta version(s) you want to use. - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` - `PDFS_2024_09_25("pdfs-2024-09-25")` - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` - `FILES_API_2025_04_14("files-api-2025-04-14")` - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` - `SKILLS_2025_10_02("skills-2025-10-02")` - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` - `USER_PROFILES_2026_09_04("user-profiles-2026-09-04")` - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` - `DREAMING_2026_04_21("dreaming-2026-04-21")` - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `COMPACT_2026_01_12("compact-2026-01-12")` - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` - `MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")` - `THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")` - `MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `COMPACT_2026_09_04("compact-2026-09-04")` - `INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")` - `MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")` - `CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")` - `SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")` - `TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")` - `Optional workspaceId` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. - `BetaSelfHostedWorkStopRequest betaSelfHostedWorkStopRequest` Request to stop a work item. #### Returns - `class 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. - `JsonValue type = "work"` The type of object (always 'work') - `String id` Work identifier (e.g., 'work_...') - `Optional acknowledgedAt` RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox - `String createdAt` RFC 3339 timestamp when work was created - `BetaSessionWorkData data` The actual work to be performed - `JsonValue type = "session"` Type of work data - `String id` Session identifier (e.g., 'session_...') - `String environmentId` Environment identifier this work belongs to (e.g., `env_...`) - `Optional latestHeartbeatAt` RFC 3339 timestamp of the most recent heartbeat - `Metadata metadata` User-provided metadata key-value pairs associated with this work item - `Optional secret` Credential payload used by the environment worker to execute this work item. May be populated when polling for work; null on all other retrieval paths. - `Optional startedAt` RFC 3339 timestamp when work execution started - `State state` Current state of the work item - `QUEUED("queued")` - `STARTING("starting")` - `ACTIVE("active")` - `STOPPING("stopping")` - `STOPPED("stopped")` - `Optional stopRequestedAt` RFC 3339 timestamp when stop was requested - `Optional stoppedAt` RFC 3339 timestamp when work execution stopped #### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.environments.work.BetaSelfHostedWork; import com.anthropic.models.beta.environments.work.BetaSelfHostedWorkStopRequest; import com.anthropic.models.beta.environments.work.WorkStopParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); WorkStopParams params = WorkStopParams.builder() .environmentId("env_011CZkZ9X2dpNyB7HsEFoRfW") .workId("work_id") .betaSelfHostedWorkStopRequest(BetaSelfHostedWorkStopRequest.builder().build()) .build(); BetaSelfHostedWork betaSelfHostedWork = client.beta().environments().work().stop(params); } } ``` ##### Response (200) ```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" }, "secret": "secret", "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } ``` ### List Work Items `WorkListPage beta().environments().work().list(params = WorkListParams.none(), requestOptions = RequestOptions.none())` **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 - `WorkListParams params` - `Optional environmentId` (path parameter) - `Optional limit` (query parameter) Maximum number of work items to return minimum: 1, maximum: 1000 - `Optional page` (query parameter) Opaque cursor from previous response for pagination - `Optional> betas` (header parameter) Optional header to specify the beta version(s) you want to use. - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` - `PDFS_2024_09_25("pdfs-2024-09-25")` - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` - `FILES_API_2025_04_14("files-api-2025-04-14")` - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` - `SKILLS_2025_10_02("skills-2025-10-02")` - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` - `USER_PROFILES_2026_09_04("user-profiles-2026-09-04")` - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` - `DREAMING_2026_04_21("dreaming-2026-04-21")` - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `COMPACT_2026_01_12("compact-2026-01-12")` - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` - `MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")` - `THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")` - `MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `COMPACT_2026_09_04("compact-2026-09-04")` - `INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")` - `MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")` - `CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")` - `SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")` - `TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")` #### Returns - `class 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. - `JsonValue type = "work"` The type of object (always 'work') - `String id` Work identifier (e.g., 'work_...') - `Optional acknowledgedAt` RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox - `String createdAt` RFC 3339 timestamp when work was created - `BetaSessionWorkData data` The actual work to be performed - `JsonValue type = "session"` Type of work data - `String id` Session identifier (e.g., 'session_...') - `String environmentId` Environment identifier this work belongs to (e.g., `env_...`) - `Optional latestHeartbeatAt` RFC 3339 timestamp of the most recent heartbeat - `Metadata metadata` User-provided metadata key-value pairs associated with this work item - `Optional secret` Credential payload used by the environment worker to execute this work item. May be populated when polling for work; null on all other retrieval paths. - `Optional startedAt` RFC 3339 timestamp when work execution started - `State state` Current state of the work item - `QUEUED("queued")` - `STARTING("starting")` - `ACTIVE("active")` - `STOPPING("stopping")` - `STOPPED("stopped")` - `Optional stopRequestedAt` RFC 3339 timestamp when stop was requested - `Optional stoppedAt` RFC 3339 timestamp when work execution stopped #### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.environments.work.WorkListPage; import com.anthropic.models.beta.environments.work.WorkListParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); WorkListPage page = client.beta().environments().work().list("env_011CZkZ9X2dpNyB7HsEFoRfW"); } } ``` ##### Response (200) ```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" }, "secret": "secret", "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 `BetaSelfHostedWork beta().environments().work().update(params, requestOptions = RequestOptions.none())` **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 - `WorkUpdateParams params` - `String environmentId` (path parameter) - `Optional workId` (path parameter) - `Optional> betas` (header parameter) Optional header to specify the beta version(s) you want to use. - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` - `PDFS_2024_09_25("pdfs-2024-09-25")` - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` - `FILES_API_2025_04_14("files-api-2025-04-14")` - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` - `SKILLS_2025_10_02("skills-2025-10-02")` - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` - `USER_PROFILES_2026_09_04("user-profiles-2026-09-04")` - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` - `DREAMING_2026_04_21("dreaming-2026-04-21")` - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `COMPACT_2026_01_12("compact-2026-01-12")` - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` - `MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")` - `THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")` - `MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `COMPACT_2026_09_04("compact-2026-09-04")` - `INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")` - `MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")` - `CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")` - `SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")` - `TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")` - `Optional workspaceId` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. - `BetaSelfHostedWorkUpdateRequest betaSelfHostedWorkUpdateRequest` Request to update work item metadata. #### Returns - `class 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. - `JsonValue type = "work"` The type of object (always 'work') - `String id` Work identifier (e.g., 'work_...') - `Optional acknowledgedAt` RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox - `String createdAt` RFC 3339 timestamp when work was created - `BetaSessionWorkData data` The actual work to be performed - `JsonValue type = "session"` Type of work data - `String id` Session identifier (e.g., 'session_...') - `String environmentId` Environment identifier this work belongs to (e.g., `env_...`) - `Optional latestHeartbeatAt` RFC 3339 timestamp of the most recent heartbeat - `Metadata metadata` User-provided metadata key-value pairs associated with this work item - `Optional secret` Credential payload used by the environment worker to execute this work item. May be populated when polling for work; null on all other retrieval paths. - `Optional startedAt` RFC 3339 timestamp when work execution started - `State state` Current state of the work item - `QUEUED("queued")` - `STARTING("starting")` - `ACTIVE("active")` - `STOPPING("stopping")` - `STOPPED("stopped")` - `Optional stopRequestedAt` RFC 3339 timestamp when stop was requested - `Optional stoppedAt` RFC 3339 timestamp when work execution stopped #### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.core.JsonValue; import com.anthropic.models.beta.environments.work.BetaSelfHostedWork; import com.anthropic.models.beta.environments.work.BetaSelfHostedWorkUpdateRequest; import com.anthropic.models.beta.environments.work.WorkUpdateParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); WorkUpdateParams params = WorkUpdateParams.builder() .environmentId("env_011CZkZ9X2dpNyB7HsEFoRfW") .workId("work_id") .betaSelfHostedWorkUpdateRequest(BetaSelfHostedWorkUpdateRequest.of(BetaSelfHostedWorkUpdateRequest.Metadata.builder() .putAdditionalProperty("foo", JsonValue.from("string")) .build())) .build(); BetaSelfHostedWork betaSelfHostedWork = client.beta().environments().work().update(params); } } ``` ##### Response (200) ```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" }, "secret": "secret", "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } ``` ### Get Queue Statistics `BetaSelfHostedWorkQueueStats beta().environments().work().stats(params = WorkStatsParams.none(), requestOptions = RequestOptions.none())` **GET** `/v1/environments/{environment_id}/work/stats` Get statistics about the work queue for an environment. #### Parameters - `WorkStatsParams params` - `Optional environmentId` (path parameter) - `Optional> betas` (header parameter) Optional header to specify the beta version(s) you want to use. - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` - `PDFS_2024_09_25("pdfs-2024-09-25")` - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` - `FILES_API_2025_04_14("files-api-2025-04-14")` - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` - `SKILLS_2025_10_02("skills-2025-10-02")` - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` - `USER_PROFILES_2026_09_04("user-profiles-2026-09-04")` - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` - `DREAMING_2026_04_21("dreaming-2026-04-21")` - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `COMPACT_2026_01_12("compact-2026-01-12")` - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` - `MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")` - `THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")` - `MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `COMPACT_2026_09_04("compact-2026-09-04")` - `INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")` - `MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")` - `CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")` - `SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")` - `TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")` - `Optional workspaceId` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `class BetaSelfHostedWorkQueueStats` Statistics about the work queue for an environment. Uses Redis Stream consumer group metrics for O(1) queries. - `JsonValue type = "work_queue_stats"` The type of object - `long depth` Number of work items waiting to be picked up (lag from consumer group) - `Optional oldestQueuedAt` RFC 3339 timestamp of oldest item in the work stream (includes both queued and pending items), null if stream empty - `long pending` Number of work items being processed (polled but not acknowledged) - `Optional workersPolling` Number of workers that have polled for work in the last 30 seconds. Requires worker_id to be sent with poll requests. #### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.environments.work.BetaSelfHostedWorkQueueStats; import com.anthropic.models.beta.environments.work.WorkStatsParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); BetaSelfHostedWorkQueueStats betaSelfHostedWorkQueueStats = client.beta().environments().work().stats("env_011CZkZ9X2dpNyB7HsEFoRfW"); } } ``` ##### Response (200) ```json { "depth": 0, "oldest_queued_at": "oldest_queued_at", "pending": 0, "type": "work_queue_stats", "workers_polling": 0 } ```