Record Heartbeat

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

注意：这些端点由 SDK 和 CLI 中提供的预构建环境工作者自动调用，用于编排与自托管沙箱环境的会话。此处仅作为参考包含；您无需直接调用它们。

记录工作项的心跳以维持租约。

Path Parameters

• environment_id: string

• work_id: string

Query Parameters

• desired_ttl_seconds: optional number

  期望的 TTL（秒）

• expected_last_heartbeat: optional string

  用于条件更新（乐观并发）的期望 last_heartbeat。使用字面量 'NO_HEARTBEAT' 来声明未认领的租约（首次心跳）。对于后续心跳，请完全回显服务器之前的 last_heartbeat 值。如果实际值不匹配，返回 412 Precondition Failed。

Header Parameters

• "anthropic-beta": optional array of AnthropicBeta

  可选的请求头，用于指定要使用的 beta 版本。

  • string

  • "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 22 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"

    • "skills-2025-10-02"

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

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

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

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

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

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

Returns

• BetaSelfHostedWorkHeartbeatResponse object { last_heartbeat, lease_extended, state, 2 more }

  记录工作项心跳后的响应。

  • last_heartbeat: string

    来自数据库的实际心跳的 RFC 3339 时间戳

  • lease_extended: boolean

    心跳是否成功延长了租约

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

    工作项的当前状态（active/stopping/stopped）

    • "queued"

    • "starting"

    • "active"

    • "stopping"

    • "stopped"

  • ttl_seconds: number

    应用于租约的有效 TTL

  • type: "work_heartbeat"

    响应类型

    • "work_heartbeat"

Example

curl https://api.anthropic.com/v1/environments/$ENVIRONMENT_ID/work/$WORK_ID/heartbeat \
    -X POST \
    -H 'anthropic-version: 2023-06-01' \
    -H 'anthropic-beta: managed-agents-2026-04-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"

Response

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