Smart Agent Teams
EndpointsRuns

Heartbeat Run

Extend the runner's lease on a running run by stamping `heartbeat_at`. `runner_id` must match the runner that claimed the run. 409 `RUN_LEASE_LOST` means stop work: the run is no longer `running` (cancelled, expired or finished) or is held by another runner. Publishes no events.

POST
/api/companies/{company_id}/runs/{run_id}/heartbeat

Extend the runner's lease on a running run by stamping heartbeat_at.

runner_id must match the runner that claimed the run. 409 RUN_LEASE_LOST means stop work: the run is no longer running (cancelled, expired or finished) or is held by another runner. Publishes no events.

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

run_id*Run Id
Formatuuid
company_id*Company Id
Formatuuid

Request Body

application/json
  1. body
runner_id*Runner Id
Length1 <= length <= 100

Response Body

Successful Response

application/json
  1. response
agent_id*Agent Id
Formatuuid
cost_cents*Cost Cents
created_at*|null
ended_at*|null
error*string|null
heartbeat_at?|null
id*Id
Formatuuid
routine_id*|null
runner_id?string|null
started_at*|null
status*Status
summary*string|null
task_id*|null
tokens_in*Tokens In
tokens_out*Tokens Out
trigger*Trigger
curl -X POST "https://example.com/api/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08/runs/497f6eca-6276-4993-bfeb-53cbbbba6f08/heartbeat" \  -H "Content-Type: application/json" \  -d '{    "runner_id": "string"  }'
{  "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",  "cost_cents": 0,  "created_at": "2019-08-24T14:15:22Z",  "ended_at": "2019-08-24T14:15:22Z",  "error": "string",  "heartbeat_at": "2019-08-24T14:15:22Z",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "routine_id": "f53c5ff7-cfb7-4f43-8b79-3421a01d8e2a",  "runner_id": "string",  "started_at": "2019-08-24T14:15:22Z",  "status": "string",  "summary": "string",  "task_id": "736fde4d-9029-4915-8189-01353d6982cb",  "tokens_in": 0,  "tokens_out": 0,  "trigger": "string"}