Run API
由
scripts/generate-api-docs.ts自动生成 —— 请勿手改 共 20 个端点
POST /runs
创建 Run(同一 Task 已有活跃 Run 时复用)
请求体
json
{
"$ref": "#/components/schemas/CreateRunDto"
}响应
| 状态码 | 说明 |
|---|---|
| 201 |
GET /runs/{id}
Run 快照(含当前等待项)
请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | path | string | ✅ |
响应
| 状态码 | 说明 |
|---|---|
| 200 |
GET /runs/{id}/approvals
列出 Run 的审批(计划级 / 工具级)
请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | path | string | ✅ |
响应
| 状态码 | 说明 |
|---|---|
| 200 |
POST /runs/{id}/approvals/{approvalId}
批准 / 拒绝审批
请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | path | string | ✅ | |
approvalId | path | string | ✅ |
请求体
json
{
"$ref": "#/components/schemas/RunApprovalDecisionDto"
}响应
| 状态码 | 说明 |
|---|---|
| 201 |
POST /runs/{id}/approvals/{approvalId}/expire
将待处理审批置为过期(定时器 / 人工)
请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | path | string | ✅ | |
approvalId | path | string | ✅ |
响应
| 状态码 | 说明 |
|---|---|
| 201 |
POST /runs/{id}/approvals/{approvalId}/revoke
撤销待处理审批(取消 Run + 退款)
请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | path | string | ✅ | |
approvalId | path | string | ✅ |
请求体
json
{
"$ref": "#/components/schemas/RunApprovalRevokeDto"
}响应
| 状态码 | 说明 |
|---|---|
| 201 |
GET /runs/{id}/budget
查询 Run 的授权额度与已用额度
请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | path | string | ✅ |
响应
| 状态码 | 说明 |
|---|---|
| 200 |
POST /runs/{id}/budget
提高授权额度(不能低于已用额度)
请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | path | string | ✅ |
响应
| 状态码 | 说明 |
|---|---|
| 201 |
POST /runs/{id}/budget/revoke
撤销预算(之后任何花钱都会被拦下)
请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | path | string | ✅ |
响应
| 状态码 | 说明 |
|---|---|
| 201 |
POST /runs/{id}/cancel
取消 Run(传播到未完成 step)
请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | path | string | ✅ |
请求体
json
{
"$ref": "#/components/schemas/RunCancelDto"
}响应
| 状态码 | 说明 |
|---|---|
| 201 |
POST /runs/{id}/commit
提交计划:开托管 + fund(需已批准的审批)
请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | path | string | ✅ |
请求体
json
{
"$ref": "#/components/schemas/CommitPlanDto"
}响应
| 状态码 | 说明 |
|---|---|
| 201 |
GET /runs/{id}/events
Run 事件流(SSE,支持 afterSeq 断线重连)
请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | path | string | ✅ | |
afterSeq | query | string | — | 只返回该 seq 之后的事件 |
响应
| 状态码 | 说明 |
|---|---|
| 200 |
POST /runs/{id}/external-events
第三方状态回传(幂等)
请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | path | string | ✅ |
请求体
json
{
"$ref": "#/components/schemas/RunExternalEventDto"
}响应
| 状态码 | 说明 |
|---|---|
| 201 |
GET /runs/{id}/interactions
Run 的交互记录(external input 的提问与回答)
请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | path | string | ✅ |
响应
| 状态码 | 说明 |
|---|---|
| 200 |
POST /runs/{id}/messages
用户输入;处于 clarifying/等输入时推进 Run
请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | path | string | ✅ |
请求体
json
{
"$ref": "#/components/schemas/RunMessageDto"
}响应
| 状态码 | 说明 |
|---|---|
| 201 |
POST /runs/{id}/pause
暂停 Run(不中断在途 step)
请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | path | string | ✅ |
请求体
json
{
"$ref": "#/components/schemas/RunCancelDto"
}响应
| 状态码 | 说明 |
|---|---|
| 201 |
POST /runs/{id}/resume
从 L0 / 当前状态恢复 Run
请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
id | path | string | ✅ |
响应
| 状态码 | 说明 |
|---|---|
| 201 |
GET /runs/active
按 taskId 查询当前活跃 Run(无则 null)
请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
taskId | query | string | ✅ |
响应
| 状态码 | 说明 |
|---|---|
| 200 |
GET /runs/latest
最近一个 Run(含终态,供工作日志恢复)
请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
taskId | query | string | ✅ |
响应
| 状态码 | 说明 |
|---|---|
| 200 |
GET /runs/metrics
Run 维度指标(用户 / 任务 / 时间范围)
请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
to | query | string | — | ISO 时间 |
from | query | string | — | ISO 时间 |
taskId | query | string | — |
响应
| 状态码 | 说明 |
|---|---|
| 200 |