Appearance
API 总览
API 分区
当前文档站重点维护四类高频接口,并补充和聊天运行态直接相关的子路由:
- 认证:
/api/auth/* - 聊天:
/api/chat - 会话:
/api/sessions* - 任务:
/api/tasks*
核心接口
聊天页和右侧运行态目前最依赖这几条接口:
POST /api/auth/loginPOST /api/chatGET /api/sessionsGET /api/sessions/:idGET /api/sessions/:id/liveGET /api/tasks/:id/statusGET /api/tasks/:id/observationsGET /api/tasks/:id/message_stateGET /api/tasks/:id/executionsGET /api/tasks/:id/logsPOST /api/tasks/:id/cancel
前端依赖的关键字段
POST /api/chat
对真实执行路径,前端至少依赖:
successsession_idtask_id
GET /api/sessions
前端至少依赖:
idstatuslast_task_id
GET /api/sessions/:id
前端至少依赖:
snapshot.sessionsnapshot.last_framesnapshot.overlays
GET /api/tasks/:id/status
前端至少依赖:
status.statusstatus.current_stepstatus.current_step_titlestatus.agent_historystatus.recent_evidence
当前页面索引
约束
只要这些接口中任意一个字段变更,就必须同步更新:
- 前端 API 类型
- 前端运行态控制器
- 至少一个 smoke test 或手工验证步骤