跳转到内容

API 契约索引

凌霄 Fastify 服务器对外暴露 HTTP REST + SSE + WebSocket + ACP JSON-RPC 全部端点。共注册 207 个路由,由 src/server.ts 装配,25 个 src/web-server/*Routes.ts 文件分模块注册。

端点族鉴权方式说明
/health/*(静态 web)、/api/v1/acp/connect公开 / 静态 / 无鉴权connect 阶段获取 connectionId + sessionToken
/api/v1/**(除 acp/connect 与 /llm/*)server tokenheader x-lingxiao-token?token= query;加固模式仅 header
/api/v1/acp(GET SSE / POST JSON-RPC)server token + ACP 凭据header acp-connection-id + acp-session-token
/llm/openai/v1/**/llm/anthropic/v1/**gateway virtual keyheader Authorization: Bearer <key>x-api-key
/api/v1/storage PUTserver token写后立即落 session_state
  • 进程内自调用(无 remoteAddress)→ 始终豁免
  • 非加固模式 localhost(127.0.0.1/::1)→ 豁免
  • 加固模式 / 非 localhost → 不豁免,429 触发冷却
  • 非 loopback 绑定且未加固 → 强警告,不门控
方法路径说明
GET/health健康探测,公开
GET/*静态 Web 资源 + SPA fallback
方法路径说明
POST/api/v1/acp/connect获取 connectionId + sessionToken
GET/api/v1/acpSSE 连接(需 ACP 凭据)
POST/api/v1/acpJSON-RPC 请求(需 ACP 凭据)
DELETE/api/v1/acp断开 ACP 连接

ACP JSON-RPC 方法包括:session/sendsession/commandsession/interruptsession/hydrate 等。

方法路径说明
GET/api/sessions列出所有会话
POST/api/sessions创建新会话
GET/api/v1/sessions/active获取活跃会话
POST/api/v1/sessions/side-thread创建侧线程
方法路径说明
GET/api/v1/settings获取设置(脱敏)
PUT/api/v1/settings更新设置
GET/api/v1/model/list列出已配置模型
PUT/api/v1/model更新 Leader 模型
GET/api/v1/prompt/list列出可用 prompt
GET/api/v1/intuition获取直觉运行时状态
方法路径说明
GET/api/v1/roles列出角色定义
GET/api/v1/commands列出 slash 命令注册表
方法路径说明
GET/api/v1/tasks列出任务
POST/api/v1/tasks创建任务
GET/api/v1/workflow/state工作流状态
POST/api/v1/workflow/toggle切换工作流模式
方法路径说明
GET/api/v1/stats会话统计
GET/api/v1/storage读取 session_state 键
PUT/api/v1/storage写入 session_state 键
方法路径说明
GET/api/v1/files列出工作区文件
GET/api/v1/files/content读取文件内容
GET/api/v1/wikiWiki 页面列表
GET/api/v1/git/statusGit 状态
POST/api/v1/git/init初始化仓库
GET/api/v1/git/platform/info平台集成信息
GET/api/v1/git/platform/mrs列出 MR/PR
POST/api/v1/git/platform/mrs创建 MR/PR
方法路径说明
GET/api/v1/worktrees列出 worktree
POST/api/v1/worktrees创建 worktree
GET/api/v1/worktrees/:id获取单个 worktree
POST/api/v1/worktrees/:id/merge合并 worktree 分支
DELETE/api/v1/worktrees/:id删除 worktree
方法路径说明
GET/api/v1/plugins列出插件
POST/api/v1/mcp-forge/generate生成 MCP 服务器
GET/api/v1/design-market/themes列出设计主题
GET/api/v1/design-market/search搜索设计素材
方法路径说明
GET/llm/openai/v1/modelsOpenAI 模型列表
POST/llm/openai/v1/chat/completionsOpenAI chat 代理
POST/llm/anthropic/v1/messagesAnthropic messages 代理
路径说明
/ws/terminal终端 PTY WebSocket
/ws/browser浏览器实时交互
状态码含义
401未授权(token 缺失或无效)
403禁止访问(加固模式限制)
404资源不存在
429限流触发(冷却期 30s)
500服务器内部错误