Stop Work

Stop Work through the OMA API.

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

Stop Work

cURL

curl --request POST \
  --url http://localhost:38080/v1/environments/{environment_id}/work/{work_id}/stop \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "force": false
}'

200

{
  "acknowledged_at": "<string>",
  "created_at": "<string>",
  "data": {
    "id": "<string>",
    "type": "session"
  },
  "environment_id": "<string>",
  "id": "<string>",
  "latest_heartbeat_at": "<string>",
  "metadata": {},
  "secret": "<string>",
  "started_at": "<string>",
  "state": "queued",
  "stop_requested_at": "<string>",
  "stopped_at": "<string>",
  "type": "work"
}

Every request requires ?beta=true.

Authorizations

omaApiKeyomaBearer

X-Api-Key · string · header · default: sk-ant-local-default · required

OMA workspace API key.

Headers

anthropic-beta · string

Optional header to specify the beta version(s) you want to use.

To use multiple betas, use a comma separated list like beta1,beta2 or specify the header multiple times for each beta.

anthropic-version · string

The version of the OMA API you want to use.

Read more about versioning and our version history here.

authorization · string | null

Path Parameters

environment_id · string · required

work_id · string · required

Query Parameters

beta · enum<boolean> · required

Selects the beta API contract for this endpoint. Must be true.

Available options: true

Body

application/json

Request to stop a work item.

force · boolean · default: false

If true, immediately stop work without graceful shutdown

Response

200

application/json

Successful Response

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.

acknowledged_at · string | null · required

RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox

created_at · string · required

RFC 3339 timestamp when work was created

data · SessionWorkData · object · required

The actual work to be performed

Show child attributes

environment_id · string · required

Environment identifier this work belongs to (e.g., env_...)

id · string · required

Work identifier (e.g., 'work_...')

latest_heartbeat_at · string | null · required

RFC 3339 timestamp of the most recent heartbeat

metadata · Metadata · object · required

User-provided metadata key-value pairs associated with this work item

Show child attributes

secret · string | null · required

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.

started_at · string | null · required

RFC 3339 timestamp when work execution started

state · enum<string> · required

Current state of the work item

Available options: queued, starting, active, stopping, stopped

stop_requested_at · string | null · required

RFC 3339 timestamp when stop was requested

stopped_at · string | null · required

RFC 3339 timestamp when work execution stopped

type · string · default: work · required

The type of object (always 'work')

Allowed value: "work"