Skip to main content
GET
轮询 worker
每个请求都必须发送 ?beta=true

授权

X-Api-Key
string
header
默认值:sk-ant-local-default
必填

OMA 工作区 API 密钥。

请求头

anthropic-beta
string

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

要使用多个 beta,请使用逗号分隔的列表(如 beta1,beta2),或为每个 beta 分别指定该请求头。

anthropic-version
string

你想使用的 OMA API 版本。

在此处阅读更多关于版本控制和我们版本历史的信息。

Anthropic-Worker-ID
string | null

正在轮询的特定 worker 的唯一标识符,用于在 OMA 控制台中跟踪环境级的 worker 聚合指标

authorization
string | null

路径参数

environment_id
string
必填

查询参数

beta
enum<boolean>
必填

为此接口启用 Beta API 合同,必须为 true

可用选项:
true
block_ms
integer | null

返回前等待 worker 到达的时长。取值必须为 1-999 毫秒。默认为非阻塞(没有可用 worker 时立即返回)。

必填范围: x >= 1
reclaim_older_than_ms
integer | null

回收超过该毫秒数仍未确认的 worker。省略时使用默认值(5000ms)。

必填范围: x >= 1

响应

SelfHostedWork · object | null

成功的响应

表示自托管环境中一个工作单元的 worker。

woker 在创建会话时,或长期休眠的会话 收到新消息时进入队列。环境 worker 会轮询待执行的 worker,并在 自托管沙箱中执行。

acknowledged_at
string | null
必填

该 worker 被确认接收并分配给自托管 sandbox 时的 RFC 3339 时间戳

created_at
string
必填

创建 worker 时的 RFC 3339 时间戳

data
SessionWorkData · object
必填

实际要执行的 worker

environment_id
string
必填

此 worker 所属的环境标识符(例如 env_...

id
string
必填

worker 标识符(例如 'work_...')

latest_heartbeat_at
string | null
必填

最近一次心跳的 RFC 3339 时间戳

metadata
元数据 · object
必填

与此 worker 关联的用户提供的元数据键值对

secret
string | null
必填

环境 worker 用于执行此 worker 的凭据载荷。轮询 worker 时可能填充该字段;其他所有获取路径上均为 null。

started_at
string | null
必填

worker 执行开始的 RFC 3339 时间戳

state
enum<string>
必填

worker 的当前状态

可用选项:
queued,
starting,
active,
stopping,
stopped
stop_requested_at
string | null
必填

请求停止时的 RFC 3339 时间戳

stopped_at
string | null
必填

worker 执行停止的 RFC 3339 时间戳

type
string
默认值:work
必填

对象类型(始终为 'work')

Allowed value: "work"