Repository Public
1---2title: Stop Work3url: https://platform.claude.com/docs/en/api/beta/environments/work/stop4---56# Stop Work78**POST** `/v1/environments/{environment_id}/work/{work_id}/stop`910Note: 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.1112Stop a work item, initiating graceful or forced shutdown.1314## Path parameters1516- `environment_id: string`1718- `work_id: string`1920## Headers2122- `"anthropic-beta": optional array of AnthropicBeta`2324 Optional header to specify the beta version(s) you want to use.2526 - `string`2728 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`2930 - `"message-batches-2024-09-24"`3132 - `"prompt-caching-2024-07-31"`3334 - `"computer-use-2024-10-22"`3536 - `"computer-use-2025-01-24"`3738 - `"pdfs-2024-09-25"`3940 - `"token-counting-2024-11-01"`4142 - `"token-efficient-tools-2025-02-19"`4344 - `"output-128k-2025-02-19"`4546 - `"files-api-2025-04-14"`4748 - `"mcp-client-2025-04-04"`4950 - `"mcp-client-2025-11-20"`5152 - `"dev-full-thinking-2025-05-14"`5354 - `"interleaved-thinking-2025-05-14"`5556 - `"code-execution-2025-05-22"`5758 - `"extended-cache-ttl-2025-04-11"`5960 - `"context-1m-2025-08-07"`6162 - `"context-management-2025-06-27"`6364 - `"model-context-window-exceeded-2025-08-26"`6566 - `"skills-2025-10-02"`6768 - `"fast-mode-2026-02-01"`6970 - `"output-300k-2026-03-24"`7172 - `"user-profiles-2026-03-24"`7374 - `"user-profiles-2026-08-18"`7576 - `"user-profiles-2026-09-04"`7778 - `"advisor-tool-2026-03-01"`7980 - `"managed-agents-2026-04-01"`8182 - `"cache-diagnosis-2026-04-07"`8384 - `"dreaming-2026-04-21"`8586 - `"thinking-token-count-2026-05-13"`8788 - `"server-side-fallback-2026-06-01"`8990 - `"server-side-fallback-2026-07-01"`9192 - `"fallback-credit-2026-06-01"`9394 - `"fallback-credit-2026-07-01"`9596 - `"agent-memory-2026-07-22"`9798 - `"mid-conversation-tool-changes-2026-07-01"`99100 - `"compact-2026-01-12"`101102 - `"computer-use-2025-11-24"`103104 - `"mcp-tunnels-2026-06-22"`105106 - `"structured-outputs-2025-11-13"`107108 - `"task-budgets-2026-03-13"`109110 - `"thinking-display-updates-2026-08-18"`111112 - `"ce-user-management-2026-07-13"`113114 - `"mid-conversation-output-config-2026-07-01"`115116 - `"thinking-binding-controls-2026-08-01"`117118 - `"mid-conversation-system-clear-at-2026-08-21"`119120 - `"compact-2026-09-04"`121122- `"anthropic-workspace-id": optional string`123124## Body parameters125126- `force: optional boolean`127128 If true, immediately stop work without graceful shutdown129130 default: false131132## Returns133134- `BetaSelfHostedWork object`135136 Work resource representing a unit of work in a self-hosted environment.137138 Work items are queued when sessions are created or when long-dormant sessions139 receive new messages. The environment worker polls for work to execute in a140 self-hosted sandbox.141142 - `type: "work"`143144 The type of object (always 'work')145146 default: work147148 - `id: string`149150 Work identifier (e.g., 'work_...')151152 - `acknowledged_at: string or null`153154 RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox155156 - `created_at: string`157158 RFC 3339 timestamp when work was created159160 - `data: BetaSessionWorkData`161162 The actual work to be performed163164 - `type: "session"`165166 Type of work data167168 - `id: string`169170 Session identifier (e.g., 'session_...')171172 - `environment_id: string`173174 Environment identifier this work belongs to (e.g., `env_...`)175176 - `latest_heartbeat_at: string or null`177178 RFC 3339 timestamp of the most recent heartbeat179180 - `metadata: map[string]`181182 User-provided metadata key-value pairs associated with this work item183184 - `secret: string or null`185186 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.187188 - `started_at: string or null`189190 RFC 3339 timestamp when work execution started191192 - `state: "queued" or "starting" or "active" or 2 more`193194 Current state of the work item195196 - `"queued"`197198 - `"starting"`199200 - `"active"`201202 - `"stopping"`203204 - `"stopped"`205206 - `stop_requested_at: string or null`207208 RFC 3339 timestamp when stop was requested209210 - `stopped_at: string or null`211212 RFC 3339 timestamp when work execution stopped213214## Example215216```bash217curl https://api.anthropic.com/v1/environments/$ENVIRONMENT_ID/work/$WORK_ID/stop \218 -H 'Content-Type: application/json' \219 -H 'anthropic-version: 2023-06-01' \220 -H 'anthropic-beta: managed-agents-2026-04-01' \221 -H "X-Api-Key: $ANTHROPIC_API_KEY" \222 -d '{}'223```224225### Response (200)226227```json228{229 "id": "id",230 "acknowledged_at": "acknowledged_at",231 "created_at": "created_at",232 "data": {233 "id": "id",234 "type": "session"235 },236 "environment_id": "environment_id",237 "latest_heartbeat_at": "latest_heartbeat_at",238 "metadata": {239 "foo": "string"240 },241 "secret": "secret",242 "started_at": "started_at",243 "state": "queued",244 "stop_requested_at": "stop_requested_at",245 "stopped_at": "stopped_at",246 "type": "work"247}248```249