Your API key:

All requests below will use this key. Your API key is sent directly to api.cueapi.ai and never stored by the docs site.

POST/v1/executions/{execution_id}/heartbeat

Execution Heartbeat

Extend the claim lease for a long-running worker execution.

execution_idstringrequiredpath

The execution UUID currently being processed.

stringbody

The worker ID that claimed this execution. Must match the original claimer.

Workers should send heartbeats every 60 seconds during long-running jobs. Each heartbeat extends the claim lease, preventing the poller's stale recovery from marking the execution as missed.

Only works on executions in delivering status. The worker ID in the header must match the worker that originally claimed the execution.

Request

bash

curl -X POST https://api.cueapi.ai/v1/executions/550e8400-e29b-41d4-a716-446655440000/heartbeat \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Worker-Id: my-worker-1"

Response

json

{
  "acknowledged": true,
  "lease_extended_until": "2026-03-23T09:20:00Z"
}

json

{"error": {"code": "execution_not_claiming", "message": "Execution is not currently being claimed", "status": 409}}

json

{"error": {"code": "not_execution_owner", "message": "Only the worker that claimed this execution can send heartbeats", "status": 403}}

Previous← Replay Execution NextVerify Execution →