This content is not available in your language yet.
Run Module
Section titled “Run Module”GET /runs/{runId}
Section titled “GET /runs/{runId}”查询 run 状态。关键字段:parentRunId、triggerType、status、agentName、effectiveAgentName、switchCount、heartbeatAt、errorCode、errorMessage。
POST /runs/{runId}/cancel
Section titled “POST /runs/{runId}/cancel”请求取消 run。返回 runId、status=cancellation_requested。
取消是异步操作,最终结果以后续 run 状态和 SSE 事件为准。
POST /runs/{runId}/guide
Section titled “POST /runs/{runId}/guide”把一个已经位于服务端 session 队列中的 run 提升为队首,并请求中断当前活跃 run。
返回 runId、status=interrupt_requested。
适用场景:
- 用户消息已经通过默认
queue模式进入队列 - 之后又决定“不等了”,希望优先切到这条消息
典型流程:
- 先用
GET /sessions/{sessionId}/queue找到目标runId - 再调用
POST /runs/{runId}/guide
POST /runs/{runId}/requeue
Section titled “POST /runs/{runId}/requeue”手动重新入队一个处于恢复隔离状态的 run。仅适用于 failed 或 timed_out 的 recovery run。
返回:runId、status=queued、previousStatus、source=manual_requeue。
POST /runs/requeue
Section titled “POST /runs/requeue”批量重新入队 recovery runs。请求体:
runIds:1 到 200 个 run id
返回 items[],每项要么是成功入队结果,要么是:
runIdstatus=errorerrorCodeerrorMessage
GET /runs/{runId}/steps
Section titled “GET /runs/{runId}/steps”查询步骤级审计:model_call、tool_call、agent_switch、agent_delegate、hook。返回 items、nextCursor。
queued → running → waiting_tool → completed / failed / cancelled / timed_out
- run 内允许
agent.switch(切换 agent)和agent.delegate(创建 subagent) - child run 通过
parentRunId关联父 run - worker 异常退出时,后续 worker 基于
heartbeatAt回收 stale run 为失败态