One change

Record Heartbeat

api/beta/environments/work/heartbeat

25 Aug 2026 03:37 UTC first seen 14 Aug 2026 The page's own history The capture it came from

Nearest release: v2.1.245, published an hour after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.

api/beta/environments/work/heartbeat Changed · +11 / -16 lines

# Record Heartbeat ## Path parameters ## Query parameters ## Headers ## Returns ## Example ### Response (200) ## Record Heartbeat ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response

from line 1

----
-title: Record Heartbeat
-url: https://platform.claude.com/docs/en/api/beta/environments/work/heartbeat
----
+# Record Heartbeat
 
-## Record Heartbeat
+**POST** `/v1/environments/{environment_id}/work/{work_id}/heartbeat`
 
-**post** `/v1/environments/{environment_id}/work/{work_id}/heartbeat`
-
 Note: 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.
 
 Record a heartbeat for a work item to maintain the lease.
 
-### Path Parameters
+## Path parameters
 
 - `environment_id: string`
 
 - `work_id: string`
 
-### Query Parameters
+## Query parameters
 
 - `desired_ttl_seconds: optional number`

from line 22

 
   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.
 
-### Header Parameters
+## Headers
 
 - `"anthropic-beta": optional array of AnthropicBeta`

from line 100

 
     - `"mid-conversation-tool-changes-2026-07-01"`
 
-### Returns
+## Returns
 
-- `BetaSelfHostedWorkHeartbeatResponse object { last_heartbeat, lease_extended, state, 2 more }`
+- `BetaSelfHostedWorkHeartbeatResponse object`
 
   Response after recording a heartbeat for a work item.

from line 136

 
     The type of response
 
-    - `"work_heartbeat"`
+    default: work_heartbeat
 
-### Example
+## Example
 
-```http
+```bash
 curl https://api.anthropic.com/v1/environments/$ENVIRONMENT_ID/work/$WORK_ID/heartbeat \
     -X POST \
     -H 'anthropic-version: 2023-06-01' \

from line 148

     -H "X-Api-Key: $ANTHROPIC_API_KEY"
 ```
 
-#### Response
+### Response (200)
 
 ```json
 {