Work

Get Work Item

get /v1/environments/{environment_id}/work/{work_id}

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

获取特定工作项的详细信息。

Path Parameters

environment_id: string
work_id: string

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

BetaSelfHostedWork object { id, acknowledged_at, created_at, 9 more }

表示自托管环境中工作单元的工作资源。

工作项在会话创建时或长期休眠的会话接收到新消息时排队。环境工作者轮询工作以在自托管沙箱中执行。
- id: string
  
  工作标识符（例如 'work_...'）
- acknowledged_at: string
  
  工作项被确认并分配给自托管沙箱时的 RFC 3339 时间戳
- created_at: string
  
  工作创建时的 RFC 3339 时间戳
- data: BetaSessionWorkData
  
  要执行的实际工作
  - id: string
    
    会话标识符（例如 'session_...'）
  - type: "session"
    
    工作数据类型
    - "session"
- environment_id: string
  
  此工作所属的环境标识符（例如 env_...）
- latest_heartbeat_at: string
  
  最近一次心跳的 RFC 3339 时间戳
- metadata: map[string]
  
  与此工作项关联的用户提供的元数据键值对
- started_at: string
  
  工作执行开始时的 RFC 3339 时间戳
- state: "queued" or "starting" or "active" or 2 more
  
  工作项的当前状态
  - "queued"
  - "starting"
  - "active"
  - "stopping"
  - "stopped"
- stop_requested_at: string
  
  请求停止时的 RFC 3339 时间戳
- stopped_at: string
  
  工作执行停止时的 RFC 3339 时间戳
- type: "work"
  
  对象类型（始终为 'work'）
  - "work"

Example

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

Response

{
  "id": "id",
  "acknowledged_at": "acknowledged_at",
  "created_at": "created_at",
  "data": {
    "id": "id",
    "type": "session"
  },
  "environment_id": "environment_id",
  "latest_heartbeat_at": "latest_heartbeat_at",
  "metadata": {
    "foo": "string"
  },
  "started_at": "started_at",
  "state": "queued",
  "stop_requested_at": "stop_requested_at",
  "stopped_at": "stopped_at",
  "type": "work"
}

Poll for Work

get /v1/environments/{environment_id}/work/poll

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

长轮询队列中的工作项。

Path Parameters

environment_id: string

Query Parameters

block_ms: optional number

返回前等待工作到达的时间。必须为 1-999 毫秒。默认为非阻塞（如果没有可用工作则立即返回）。
reclaim_older_than_ms: optional number

回收超过此毫秒数的未确认工作项。如果省略，使用默认值（5000ms）。

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"
"Anthropic-Worker-ID": optional string

特定轮询工作者的唯一标识符，用于在控制台中跟踪聚合的环境级工作指标

Returns

BetaSelfHostedWork object { id, acknowledged_at, created_at, 9 more }

表示自托管环境中工作单元的工作资源。

工作项在会话创建时或长期休眠的会话接收到新消息时排队。环境工作者轮询工作以在自托管沙箱中执行。
- id: string
  
  工作标识符（例如 'work_...'）
- acknowledged_at: string
  
  工作项被确认并分配给自托管沙箱时的 RFC 3339 时间戳
- created_at: string
  
  工作创建时的 RFC 3339 时间戳
- data: BetaSessionWorkData
  
  要执行的实际工作
  - id: string
    
    会话标识符（例如 'session_...'）
  - type: "session"
    
    工作数据类型
    - "session"
- environment_id: string
  
  此工作所属的环境标识符（例如 env_...）
- latest_heartbeat_at: string
  
  最近一次心跳的 RFC 3339 时间戳
- metadata: map[string]
  
  与此工作项关联的用户提供的元数据键值对
- started_at: string
  
  工作执行开始时的 RFC 3339 时间戳
- state: "queued" or "starting" or "active" or 2 more
  
  工作项的当前状态
  - "queued"
  - "starting"
  - "active"
  - "stopping"
  - "stopped"
- stop_requested_at: string
  
  请求停止时的 RFC 3339 时间戳
- stopped_at: string
  
  工作执行停止时的 RFC 3339 时间戳
- type: "work"
  
  对象类型（始终为 'work'）
  - "work"

Example

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

Response

{
  "id": "id",
  "acknowledged_at": "acknowledged_at",
  "created_at": "created_at",
  "data": {
    "id": "id",
    "type": "session"
  },
  "environment_id": "environment_id",
  "latest_heartbeat_at": "latest_heartbeat_at",
  "metadata": {
    "foo": "string"
  },
  "started_at": "started_at",
  "state": "queued",
  "stop_requested_at": "stop_requested_at",
  "stopped_at": "stopped_at",
  "type": "work"
}

Acknowledge Work

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

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

确认收到工作项，将其从 'queued' 转换为 'starting' 并从队列中移除。

Path Parameters

environment_id: string
work_id: string

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

BetaSelfHostedWork object { id, acknowledged_at, created_at, 9 more }

表示自托管环境中工作单元的工作资源。

工作项在会话创建时或长期休眠的会话接收到新消息时排队。环境工作者轮询工作以在自托管沙箱中执行。
- id: string
  
  工作标识符（例如 'work_...'）
- acknowledged_at: string
  
  工作项被确认并分配给自托管沙箱时的 RFC 3339 时间戳
- created_at: string
  
  工作创建时的 RFC 3339 时间戳
- data: BetaSessionWorkData
  
  要执行的实际工作
  - id: string
    
    会话标识符（例如 'session_...'）
  - type: "session"
    
    工作数据类型
    - "session"
- environment_id: string
  
  此工作所属的环境标识符（例如 env_...）
- latest_heartbeat_at: string
  
  最近一次心跳的 RFC 3339 时间戳
- metadata: map[string]
  
  与此工作项关联的用户提供的元数据键值对
- started_at: string
  
  工作执行开始时的 RFC 3339 时间戳
- state: "queued" or "starting" or "active" or 2 more
  
  工作项的当前状态
  - "queued"
  - "starting"
  - "active"
  - "stopping"
  - "stopped"
- stop_requested_at: string
  
  请求停止时的 RFC 3339 时间戳
- stopped_at: string
  
  工作执行停止时的 RFC 3339 时间戳
- type: "work"
  
  对象类型（始终为 'work'）
  - "work"

Example

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

Response

{
  "id": "id",
  "acknowledged_at": "acknowledged_at",
  "created_at": "created_at",
  "data": {
    "id": "id",
    "type": "session"
  },
  "environment_id": "environment_id",
  "latest_heartbeat_at": "latest_heartbeat_at",
  "metadata": {
    "foo": "string"
  },
  "started_at": "started_at",
  "state": "queued",
  "stop_requested_at": "stop_requested_at",
  "stopped_at": "stopped_at",
  "type": "work"
}

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"
}

Stop Work

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

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

停止工作项，启动优雅或强制关闭。

Path Parameters

environment_id: string
work_id: string

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"

Body Parameters

force: optional boolean

如果为 true，立即停止工作而不进行优雅关闭

Returns

BetaSelfHostedWork object { id, acknowledged_at, created_at, 9 more }

表示自托管环境中工作单元的工作资源。

工作项在会话创建时或长期休眠的会话接收到新消息时排队。环境工作者轮询工作以在自托管沙箱中执行。
- id: string
  
  工作标识符（例如 'work_...'）
- acknowledged_at: string
  
  工作项被确认并分配给自托管沙箱时的 RFC 3339 时间戳
- created_at: string
  
  工作创建时的 RFC 3339 时间戳
- data: BetaSessionWorkData
  
  要执行的实际工作
  - id: string
    
    会话标识符（例如 'session_...'）
  - type: "session"
    
    工作数据类型
    - "session"
- environment_id: string
  
  此工作所属的环境标识符（例如 env_...）
- latest_heartbeat_at: string
  
  最近一次心跳的 RFC 3339 时间戳
- metadata: map[string]
  
  与此工作项关联的用户提供的元数据键值对
- started_at: string
  
  工作执行开始时的 RFC 3339 时间戳
- state: "queued" or "starting" or "active" or 2 more
  
  工作项的当前状态
  - "queued"
  - "starting"
  - "active"
  - "stopping"
  - "stopped"
- stop_requested_at: string
  
  请求停止时的 RFC 3339 时间戳
- stopped_at: string
  
  工作执行停止时的 RFC 3339 时间戳
- type: "work"
  
  对象类型（始终为 'work'）
  - "work"

Example

curl https://api.anthropic.com/v1/environments/$ENVIRONMENT_ID/work/$WORK_ID/stop \
    -H 'Content-Type: application/json' \
    -H 'anthropic-version: 2023-06-01' \
    -H 'anthropic-beta: managed-agents-2026-04-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY" \
    -d '{}'

Response

{
  "id": "id",
  "acknowledged_at": "acknowledged_at",
  "created_at": "created_at",
  "data": {
    "id": "id",
    "type": "session"
  },
  "environment_id": "environment_id",
  "latest_heartbeat_at": "latest_heartbeat_at",
  "metadata": {
    "foo": "string"
  },
  "started_at": "started_at",
  "state": "queued",
  "stop_requested_at": "stop_requested_at",
  "stopped_at": "stopped_at",
  "type": "work"
}

List Work Items

get /v1/environments/{environment_id}/work

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

列出环境中的工作项。

Path Parameters

environment_id: string

Query Parameters

limit: optional number

返回的最大工作项数量
page: optional string

用于分页的上一个响应中的不透明游标

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

BetaSelfHostedWorkListResponse object { data, next_page }

使用游标分页列出工作项时的响应。
- data: array of BetaSelfHostedWork
  
  工作项列表
  - id: string
    
    工作标识符（例如 'work_...'）
  - acknowledged_at: string
    
    工作项被确认并分配给自托管沙箱时的 RFC 3339 时间戳
  - created_at: string
    
    工作创建时的 RFC 3339 时间戳
  - data: BetaSessionWorkData
    
    要执行的实际工作
    - id: string
      
      会话标识符（例如 'session_...'）
    - type: "session"
      
      工作数据类型
      - "session"
  - environment_id: string
    
    此工作所属的环境标识符（例如 env_...）
  - latest_heartbeat_at: string
    
    最近一次心跳的 RFC 3339 时间戳
  - metadata: map[string]
    
    与此工作项关联的用户提供的元数据键值对
  - started_at: string
    
    工作执行开始时的 RFC 3339 时间戳
  - state: "queued" or "starting" or "active" or 2 more
    
    工作项的当前状态
    - "queued"
    - "starting"
    - "active"
    - "stopping"
    - "stopped"
  - stop_requested_at: string
    
    请求停止时的 RFC 3339 时间戳
  - stopped_at: string
    
    工作执行停止时的 RFC 3339 时间戳
  - type: "work"
    
    对象类型（始终为 'work'）
    - "work"
- next_page: string
  
  用于获取下一页结果的不透明游标

Example

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

Response

{
  "data": [
    {
      "id": "id",
      "acknowledged_at": "acknowledged_at",
      "created_at": "created_at",
      "data": {
        "id": "id",
        "type": "session"
      },
      "environment_id": "environment_id",
      "latest_heartbeat_at": "latest_heartbeat_at",
      "metadata": {
        "foo": "string"
      },
      "started_at": "started_at",
      "state": "queued",
      "stop_requested_at": "stop_requested_at",
      "stopped_at": "stopped_at",
      "type": "work"
    }
  ],
  "next_page": "next_page"
}

Update Work Item

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

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

使用合并语义更新工作项元数据。

Path Parameters

environment_id: string
work_id: string

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"

Body Parameters

metadata: map[string]

元数据补丁。将键设置为字符串以插入或更新，设置为 null 以删除。省略该字段以保留现有元数据。

Returns

BetaSelfHostedWork object { id, acknowledged_at, created_at, 9 more }

表示自托管环境中工作单元的工作资源。

工作项在会话创建时或长期休眠的会话接收到新消息时排队。环境工作者轮询工作以在自托管沙箱中执行。
- id: string
  
  工作标识符（例如 'work_...'）
- acknowledged_at: string
  
  工作项被确认并分配给自托管沙箱时的 RFC 3339 时间戳
- created_at: string
  
  工作创建时的 RFC 3339 时间戳
- data: BetaSessionWorkData
  
  要执行的实际工作
  - id: string
    
    会话标识符（例如 'session_...'）
  - type: "session"
    
    工作数据类型
    - "session"
- environment_id: string
  
  此工作所属的环境标识符（例如 env_...）
- latest_heartbeat_at: string
  
  最近一次心跳的 RFC 3339 时间戳
- metadata: map[string]
  
  与此工作项关联的用户提供的元数据键值对
- started_at: string
  
  工作执行开始时的 RFC 3339 时间戳
- state: "queued" or "starting" or "active" or 2 more
  
  工作项的当前状态
  - "queued"
  - "starting"
  - "active"
  - "stopping"
  - "stopped"
- stop_requested_at: string
  
  请求停止时的 RFC 3339 时间戳
- stopped_at: string
  
  工作执行停止时的 RFC 3339 时间戳
- type: "work"
  
  对象类型（始终为 'work'）
  - "work"

Example

curl https://api.anthropic.com/v1/environments/$ENVIRONMENT_ID/work/$WORK_ID \
    -H 'Content-Type: application/json' \
    -H 'anthropic-version: 2023-06-01' \
    -H 'anthropic-beta: managed-agents-2026-04-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY" \
    -d '{
          "metadata": {
            "foo": "string"
          }
        }'

Response

{
  "id": "id",
  "acknowledged_at": "acknowledged_at",
  "created_at": "created_at",
  "data": {
    "id": "id",
    "type": "session"
  },
  "environment_id": "environment_id",
  "latest_heartbeat_at": "latest_heartbeat_at",
  "metadata": {
    "foo": "string"
  },
  "started_at": "started_at",
  "state": "queued",
  "stop_requested_at": "stop_requested_at",
  "stopped_at": "stopped_at",
  "type": "work"
}

Get Queue Statistics

get /v1/environments/{environment_id}/work/stats

获取环境工作队列的统计信息。

Path Parameters

environment_id: string

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

BetaSelfHostedWorkQueueStats object { depth, oldest_queued_at, pending, 2 more }

环境工作队列的统计信息。

使用 Redis Stream 消费者组指标进行 O(1) 查询。
- depth: number
  
  等待被拾取的工作项数量（消费者组的滞后）
- oldest_queued_at: string
  
  工作流中最旧项的 RFC 3339 时间戳（包括排队和待处理项），如果流为空则为 null
- pending: number
  
  正在处理的工作项数量（已轮询但未确认）
- type: "work_queue_stats"
  
  对象类型
  - "work_queue_stats"
- workers_polling: number
  
  在过去 30 秒内轮询过工作的工作器数量。需要在轮询请求中发送 worker_id。

Example

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

Response

{
  "depth": 0,
  "oldest_queued_at": "oldest_queued_at",
  "pending": 0,
  "type": "work_queue_stats",
  "workers_polling": 0
}

Domain Types

Beta Self Hosted Work

BetaSelfHostedWork object { id, acknowledged_at, created_at, 9 more }

表示自托管环境中工作单元的工作资源。

工作项在会话创建时或长期休眠的会话接收到新消息时排队。环境工作者轮询工作以在自托管沙箱中执行。
- id: string
  
  工作标识符（例如 'work_...'）
- acknowledged_at: string
  
  工作项被确认并分配给自托管沙箱时的 RFC 3339 时间戳
- created_at: string
  
  工作创建时的 RFC 3339 时间戳
- data: BetaSessionWorkData
  
  要执行的实际工作
  - id: string
    
    会话标识符（例如 'session_...'）
  - type: "session"
    
    工作数据类型
    - "session"
- environment_id: string
  
  此工作所属的环境标识符（例如 env_...）
- latest_heartbeat_at: string
  
  最近一次心跳的 RFC 3339 时间戳
- metadata: map[string]
  
  与此工作项关联的用户提供的元数据键值对
- started_at: string
  
  工作执行开始时的 RFC 3339 时间戳
- state: "queued" or "starting" or "active" or 2 more
  
  工作项的当前状态
  - "queued"
  - "starting"
  - "active"
  - "stopping"
  - "stopped"
- stop_requested_at: string
  
  请求停止时的 RFC 3339 时间戳
- stopped_at: string
  
  工作执行停止时的 RFC 3339 时间戳
- type: "work"
  
  对象类型（始终为 'work'）
  - "work"

Beta Self Hosted Work Heartbeat Response

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"

Beta Self Hosted Work List Response

BetaSelfHostedWorkListResponse object { data, next_page }

使用游标分页列出工作项时的响应。
- data: array of BetaSelfHostedWork
  
  工作项列表
  - id: string
    
    工作标识符（例如 'work_...'）
  - acknowledged_at: string
    
    工作项被确认并分配给自托管沙箱时的 RFC 3339 时间戳
  - created_at: string
    
    工作创建时的 RFC 3339 时间戳
  - data: BetaSessionWorkData
    
    要执行的实际工作
    - id: string
      
      会话标识符（例如 'session_...'）
    - type: "session"
      
      工作数据类型
      - "session"
  - environment_id: string
    
    此工作所属的环境标识符（例如 env_...）
  - latest_heartbeat_at: string
    
    最近一次心跳的 RFC 3339 时间戳
  - metadata: map[string]
    
    与此工作项关联的用户提供的元数据键值对
  - started_at: string
    
    工作执行开始时的 RFC 3339 时间戳
  - state: "queued" or "starting" or "active" or 2 more
    
    工作项的当前状态
    - "queued"
    - "starting"
    - "active"
    - "stopping"
    - "stopped"
  - stop_requested_at: string
    
    请求停止时的 RFC 3339 时间戳
  - stopped_at: string
    
    工作执行停止时的 RFC 3339 时间戳
  - type: "work"
    
    对象类型（始终为 'work'）
    - "work"
- next_page: string
  
  用于获取下一页结果的不透明游标

Beta Self Hosted Work Queue Stats

BetaSelfHostedWorkQueueStats object { depth, oldest_queued_at, pending, 2 more }

环境工作队列的统计信息。

使用 Redis Stream 消费者组指标进行 O(1) 查询。
- depth: number
  
  等待被拾取的工作项数量（消费者组的滞后）
- oldest_queued_at: string
  
  工作流中最旧项的 RFC 3339 时间戳（包括排队和待处理项），如果流为空则为 null
- pending: number
  
  正在处理的工作项数量（已轮询但未确认）
- type: "work_queue_stats"
  
  对象类型
  - "work_queue_stats"
- workers_polling: number
  
  在过去 30 秒内轮询过工作的工作器数量。需要在轮询请求中发送 worker_id。

Beta Self Hosted Work Stop Request

BetaSelfHostedWorkStopRequest object { force }

停止工作项的请求。
- force: optional boolean
  
  如果为 true，立即停止工作而不进行优雅关闭

Beta Self Hosted Work Update Request

BetaSelfHostedWorkUpdateRequest object { metadata }

更新工作项元数据的请求。
- metadata: map[string]
  
  元数据补丁。将键设置为字符串以插入或更新，设置为 null 以删除。省略该字段以保留现有元数据。

Beta Session Work Data

BetaSessionWorkData object { id, type }

会话工作项的工作数据。

此资源类型用于工作表示需要在自托管环境中执行的会话时。
- id: string
  
  会话标识符（例如 'session_...'）
- type: "session"
  
  工作数据类型
  - "session"