更新 worker

通过 OMA API 更新 worker。

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

更新 worker

cURL

curl --request POST \
  --url http://localhost:38080/v1/environments/{environment_id}/work/{work_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "metadata": {}
}'

200

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

每个请求都必须发送 ?beta=true。

授权

omaApiKeyomaBearer

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

OMA 工作区 API 密钥。

请求头

anthropic-beta · string

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

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

anthropic-version · string

你想使用的 OMA API 版本。

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

路径参数

environment_id · string · 必填

work_id · string · 必填

查询参数

beta · enum<boolean> · 必填

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

可用选项: true

请求体

application/json

更新 worker 元数据的请求。

metadata · 元数据 · object · 必填

元数据补丁。将某个键设为字符串可新增或更新该键，设为 null 可删除该键。省略该字段则保留现有元数据。

Show child attributes

响应

200

application/json

成功的响应

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

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

acknowledged_at · string | null · 必填

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

created_at · string · 必填

创建 worker 时的 RFC 3339 时间戳

data · SessionWorkData · object · 必填

实际要执行的 worker

Show child attributes

environment_id · string · 必填

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

id · string · 必填

worker 标识符（例如 'work_...'）

latest_heartbeat_at · string | null · 必填

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

metadata · 元数据 · object · 必填

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

Show child attributes

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"