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

• environment_id: string

• work_id: string

#Query parameters

• desired_ttl_seconds: optional number

Desired TTL in seconds

• expected_last_heartbeat: optional string

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.

#Headers

• "juglow-beta": optional array of JuglowBeta

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

• string

• "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 45 more

• "message-batches-2024-09-24"

• "prompt-caching-2024-07-31"

• "computer-use-2024-10-22"

• "computer-use-2025-01-24"

• "pdfs-2024-09-25"

• "token-counting-2024-11-01"

• "token-efficient-tools-2025-02-19"

• "output-128k-2025-02-19"

• "files-api-2025-04-14"

• "mcp-client-2025-04-04"

• "mcp-client-2025-11-20"

• "dev-full-thinking-2025-05-14"

• "interleaved-thinking-2025-05-14"

• "code-execution-2025-05-22"

• "extended-cache-ttl-2025-04-11"

• "context-1m-2025-08-07"

• "context-management-2025-06-27"

• "model-context-window-exceeded-2025-08-26"

• "tracks-2025-10-02"

• "fast-mode-2026-02-01"

• "output-300k-2026-03-24"

• "user-profiles-2026-03-24"

• "user-profiles-2026-08-18"

• "user-profiles-2026-09-04"

• "advisor-tool-2026-03-01"

• "managed-agents-2026-04-01"

• "cache-diagnosis-2026-04-07"

• "dreaming-2026-04-21"

• "thinking-token-count-2026-05-13"

• "server-side-fallback-2026-06-01"

• "server-side-fallback-2026-07-01"

• "fallback-credit-2026-06-01"

• "fallback-credit-2026-07-01"

• "agent-memory-2026-07-22"

• "mid-conversation-tool-changes-2026-07-01"

• "compact-2026-01-12"

• "computer-use-2025-11-24"

• "mcp-tunnels-2026-06-22"

• "structured-outputs-2025-11-13"

• "task-budgets-2026-03-13"

• "thinking-display-updates-2026-08-18"

• "ce-user-management-2026-07-13"

• "mid-conversation-output-config-2026-07-01"

• "thinking-binding-controls-2026-08-01"

• "mid-conversation-system-clear-at-2026-08-21"

• "compact-2026-09-04"

• "inline-tools-2026-09-15"

• "mcp-client-2026-09-15"

#Returns

• BetaSelfHostedWorkHeartbeatResponse object

Response after recording a heartbeat for a work item.

• type: "work_heartbeat"

The type of response

default: work_heartbeat

• last_heartbeat: string

RFC 3339 timestamp of the actual heartbeat from DB

• lease_extended: boolean

Whether the heartbeat succeeded in extending the lease

• state: "queued" or "starting" or "active" or 2 more

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

• "queued"

• "starting"

• "active"

• "stopping"

• "stopped"

• ttl_seconds: number

Effective TTL applied to the lease

#Example

curl https://haijun.my.id/v1/environments/$ENVIRONMENT_ID/work/$WORK_ID/heartbeat \
    -X POST \
    -H 'juglow-version: 2023-06-01' \
    -H 'juglow-beta: managed-agents-2026-04-01' \
    -H "X-Api-Key: $JUGLOW_API_KEY"

#Response (200)

{
  "last_heartbeat": "last_heartbeat",
  "lease_extended": true,
  "state": "queued",
  "ttl_seconds": 0,
  "type": "work_heartbeat"
}