Record Heartbeat

Record Heartbeat through the OMA API.

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

Record Heartbeat

cURL

curl --request POST \
  --url http://localhost:38080/v1/environments/{environment_id}/work/{work_id}/heartbeat \
  --header 'X-Api-Key: <api-key>'

200

{
  "last_heartbeat": "<string>",
  "lease_extended": true,
  "state": "queued",
  "ttl_seconds": 123,
  "type": "work_heartbeat"
}

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

desired_ttl_seconds · integer | null

Desired TTL in seconds

expected_last_heartbeat · string | null

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.

Response

200

application/json

Successful Response

Response after recording a heartbeat for a work item.

last_heartbeat · string · required

RFC 3339 timestamp of the actual heartbeat from DB

lease_extended · boolean · required

Whether the heartbeat succeeded in extending the lease

state · enum<string> · required

Current state of the work item (active/stopping/stopped)

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

ttl_seconds · integer · required

Effective TTL applied to the lease

type · string · default: work_heartbeat · required

The type of response

Allowed value: "work_heartbeat"