Skip to content

Tasks API

GET /api/tasks/:id/status

用于恢复任务执行状态和步骤信息。

鉴权

默认需要登录。开启鉴权时,任务访问会校验 session 所有权或持久化 plan 所有权。

典型返回结构

json
{
  "success": true,
  "status": {
    "status": "running",
    "current_step": 1,
    "current_step_title": "Navigate to page",
    "recent_evidence": [],
    "agent_history": []
  }
}

前端关心的字段

  • status.status
  • status.current_step
  • status.current_step_title
  • status.agent_history
  • status.recent_evidence

GET /api/tasks/:id/observations

主要用作右侧实时画面的补链。

典型返回结构

json
{
  "success": true,
  "data": {
    "task_id": "task-uuid",
    "observations": []
  }
}

用途

  • session snapshot 没拿到画面时补截图
  • 从 observation 中提取 artifact 图像

约束

  • 这条接口是补链,不应该替代 session snapshot 成为主数据源
  • 如果 observations 有图而页面没图,优先检查前端对 payload 结构的解析

常见错误

状态码场景
400task id 非法
401需要鉴权但未登录
404task 不存在或对当前用户不可见

其他高频任务接口

方法路径说明
GET/api/tasks/:id获取任务详情
GET/api/tasks/:id/logs拉取任务日志
GET/api/tasks/:id/events任务事件 SSE
GET/api/tasks/:id/stream任务事件 SSE 别名
GET/api/tasks/:id/message_state获取聊天消息态
GET/api/tasks/:id/executions获取执行记录
POST/api/tasks/:id/manual_takeover请求手动接管
POST/api/tasks/:id/manual_takeover/resume手动接管后恢复
GET/api/tasks/:id/screenshot获取最新截图
POST/api/tasks/:id/user_takeover发送用户接管信号
POST/api/tasks/:id/cancel取消运行中的任务

联调建议

  • 要恢复右侧执行进度,优先看 status,不要先看 observations
  • observations 有图但页面没图,通常说明前端补链解析有问题,而不是截图生产链路先坏了。
  • 如果需要排查任务执行轨迹,再看 logsevents/streamexecutions,不要把它们当成首页级主数据源。

SoulBrowser Documentation