跳到主要内容

API 参考

这一页提供当前代码结构对应的 API 总览，重点帮助你快速定位接口边界，以及会话、团队、渠道、外部编码工具之间的关系。

基础信息​

  • Base URL: http://localhost:8000
  • API 前缀：/api
  • WebSocket：ws://localhost:8000/ws

WebSocket​

WebSocket 主要用于：

  • 流式回复
  • 工具调用通知
  • 后台任务状态
  • 工作流与子智能体事件

接口分组​

系统​

方法路径说明
GET/api/system/health健康检查
GET/api/system/info系统信息
POST/api/system/notify发送系统通知
GET/api/system/tray/status托盘状态
POST/api/system/tray/minimize最小化到托盘
POST/api/system/tray/restore从托盘恢复
GET/api/system/hotkeys获取快捷键列表
POST/api/system/hotkeys/register注册快捷键
DELETE/api/system/hotkeys/{hotkey}删除快捷键
GET/api/system/autostart获取自启动状态
POST/api/system/autostart设置自启动

认证​

方法路径说明
GET/api/auth/status获取认证状态
POST/api/auth/setup首次设置密码
POST/api/auth/login登录
POST/api/auth/logout登出
POST/api/auth/change-password修改密码

设置​

方法路径说明
GET/api/settings获取全部设置
PUT/api/settings保存全部设置
GET/api/settings/providers获取 Provider 元数据
GET/api/settings/security/dangerous-patterns获取危险命令规则
POST/api/settings/test-connection测试模型连接
POST/api/settings/workspace/select-directory选择工作空间目录
GET/api/settings/workspace/info获取工作空间信息
POST/api/settings/workspace/clean-temp清理临时目录
POST/api/settings/workspace/set-path设置工作空间路径
GET/api/settings/export导出配置
POST/api/settings/import导入配置

外部编码工具​

方法路径说明
GET/api/settings/external-coding-tools获取外部编码工具配置
PUT/api/settings/external-coding-tools保存外部编码工具配置
POST/api/settings/external-coding-tools/check检查某个 profile 是否可用

聊天与会话​

方法路径说明
POST/api/chat/send发送消息
GET/api/chat/sessions获取会话列表
POST/api/chat/sessions创建会话
GET/api/chat/sessions/{session_id}获取会话详情
PUT/api/chat/sessions/{session_id}更新会话
DELETE/api/chat/sessions/{session_id}删除会话
GET/api/chat/sessions/{session_id}/messages获取消息列表
DELETE/api/chat/sessions/{session_id}/messages/{message_id}删除单条消息
DELETE/api/chat/sessions/{session_id}/messages清空消息
GET/api/chat/sessions/{session_id}/export导出会话
PUT/api/chat/sessions/{session_id}/summary保存摘要
DELETE/api/chat/sessions/{session_id}/summary删除摘要
POST/api/chat/sessions/{session_id}/summarize触发摘要生成
GET/api/chat/sessions/{session_id}/config获取会话自定义配置
PUT/api/chat/sessions/{session_id}/config保存会话自定义配置
DELETE/api/chat/sessions/{session_id}/config清空会话自定义配置

会话配置说明​

会话配置接口用于保存当前会话的局部覆盖，当前实现支持：

  • model
  • persona

保存后会标记 use_custom_config=true；重置时会清空 session_model_config、session_persona_config 并把 use_custom_config 设回 false。

普通会话运行时优先级：

  1. 会话自定义配置
  2. 全局 Provider 配置
  3. Provider 默认元数据

工具​

方法路径说明
POST/api/tools/execute执行工具
GET/api/tools/list获取工具列表
GET/api/tools/conversations获取工具对话历史
GET/api/tools/conversations/stats获取工具会话统计
DELETE/api/tools/conversations清空工具历史
GET/api/tools/audit/history获取审计历史
GET/api/tools/audit/stats获取审计统计
DELETE/api/tools/audit/history清理审计历史
POST/api/tools/audit/cleanup执行审计清理

技能​

方法路径说明
GET/api/skills获取技能列表
POST/api/skills创建技能
POST/api/skills/reload重载技能
GET/api/skills/{name}获取技能详情
PUT/api/skills/{name}更新技能
DELETE/api/skills/{name}删除技能
POST/api/skills/{name}/toggle启用或禁用技能
GET/api/skills/{name}/config/schema获取配置 schema
GET/api/skills/{name}/config获取技能配置
PUT/api/skills/{name}/config保存技能配置
GET/api/skills/{name}/config/status获取配置状态
POST/api/skills/{name}/config/fix自动修复配置
GET/api/skills/{name}/config/help获取配置帮助

记忆​

方法路径说明
GET/api/memory/long-term获取长期记忆
PUT/api/memory/long-term更新长期记忆
GET/api/memory/stats获取记忆统计
GET/api/memory/recent获取近期记忆
POST/api/memory/search搜索记忆

渠道​

方法路径说明
GET/api/channels/list获取渠道摘要
GET/api/channels/status获取渠道运行状态
POST/api/channels/test测试渠道连接
POST/api/channels/update保存并重载渠道配置
GET/api/channels/{channel}/config获取单个渠道配置
POST/api/channels/wechat/login/start启动微信登录
POST/api/channels/wechat/login/poll轮询微信登录结果

渠道配置与路由​

渠道账号层当前支持：

  • routing_mode
  • external_coding_profile

其中 routing_mode 只允许：

  • ai
  • direct

如果某个账号设置为 direct 却没有绑定 external_coding_profile，渠道配置校验不会通过。

定时任务​

方法路径说明
GET/api/cron/jobs获取任务列表
POST/api/cron/jobs创建任务
GET/api/cron/jobs/{job_id}获取任务详情
PUT/api/cron/jobs/{job_id}更新任务
DELETE/api/cron/jobs/{job_id}删除任务
POST/api/cron/jobs/{job_id}/run立即执行任务
POST/api/cron/jobs/batch批量创建任务
POST/api/cron/jobs/batch-delete批量删除任务
GET/api/cron/jobs/{job_id}/messages获取任务消息
POST/api/cron/jobs/{job_id}/session/cleanup清理任务会话
POST/api/cron/jobs/{job_id}/session/reset重置任务会话
POST/api/cron/validate校验 cron 表达式

智能体团队​

方法路径说明
GET/api/agent-teams/获取团队列表
POST/api/agent-teams/创建团队
GET/api/agent-teams/{team_id}获取团队详情
PUT/api/agent-teams/{team_id}更新团队
DELETE/api/agent-teams/{team_id}删除团队
GET/api/agent-teams/{team_id}/config获取团队模型配置
PUT/api/agent-teams/{team_id}/config保存团队模型配置
DELETE/api/agent-teams/{team_id}/config清空团队模型配置

团队工作流说明​

workflow_run 支持两种入口：

  • 预定义团队：传 team_name
  • 自定义一次性工作流：传 mode 和 agents

如果使用预定义团队，执行时会自动加载：

  • 团队的 mode
  • 团队的 agents
  • 团队的 cross_review
  • 团队的 enable_skills
  • 团队专属模型配置

模型优先级：

  1. 团队专属模型配置
  2. 会话模型覆盖
  3. 全局模型配置
  4. Provider 默认元数据

后台任务​

方法路径说明
GET/api/tasks/获取任务列表
GET/api/tasks/stats获取任务统计
GET/api/tasks/{task_id}获取任务详情
DELETE/api/tasks/{task_id}删除任务
POST/api/tasks/{task_id}/delete兼容型删除入口

队列​

方法路径说明
GET/api/queue/stats获取队列统计
POST/api/queue/cancel取消正在处理的任务
GET/api/queue/active-tasks获取活动任务

人格​

方法路径说明
GET/api/personalities获取人格列表
GET/api/personalities/{personality_id}获取人格详情
POST/api/personalities创建人格
PUT/api/personalities/{personality_id}更新人格
DELETE/api/personalities/{personality_id}删除人格
POST/api/personalities/{personality_id}/duplicate复制人格

推荐联调顺序​

  1. GET /api/system/health
  2. GET /api/settings
  3. GET /api/channels/list
  4. GET /api/settings/external-coding-tools
  5. GET /api/agent-teams/
  6. GET /api/chat/sessions
  7. POST /api/chat/send

相关文档​