Skip to content

API 总览

API 分区

当前文档站重点维护四类高频接口,并补充和聊天运行态直接相关的子路由:

  • 认证:/api/auth/*
  • 聊天:/api/chat
  • 会话:/api/sessions*
  • 任务:/api/tasks*

核心接口

聊天页和右侧运行态目前最依赖这几条接口:

  • POST /api/auth/login
  • POST /api/chat
  • GET /api/sessions
  • GET /api/sessions/:id
  • GET /api/sessions/:id/live
  • GET /api/tasks/:id/status
  • GET /api/tasks/:id/observations
  • GET /api/tasks/:id/message_state
  • GET /api/tasks/:id/executions
  • GET /api/tasks/:id/logs
  • POST /api/tasks/:id/cancel

前端依赖的关键字段

POST /api/chat

对真实执行路径,前端至少依赖:

  • success
  • session_id
  • task_id

GET /api/sessions

前端至少依赖:

  • id
  • status
  • last_task_id

GET /api/sessions/:id

前端至少依赖:

  • snapshot.session
  • snapshot.last_frame
  • snapshot.overlays

GET /api/tasks/:id/status

前端至少依赖:

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

当前页面索引

约束

只要这些接口中任意一个字段变更,就必须同步更新:

  • 前端 API 类型
  • 前端运行态控制器
  • 至少一个 smoke test 或手工验证步骤

SoulBrowser Documentation