前端 API 文档

ResearchX 现在提供了基于 OpenAPI 的前端接口文档，方便集中查看 Web 端可调用的接口、请求参数、响应结构和鉴权方式。

入口

• Swagger UI: /swagger
• OpenAPI JSON: /openapi.json

Agent 调用文档

• LLM API 操作手册：按项目、workspace、agent ticket、权限确认串起完整调用流程
• 数据分析 API Cookbook：上传数据、创建分析任务、读取结果、处理失败的示例
• Agent API Profile：推荐暴露给外部大模型的精简工具集合

模块导航

• admin
  • 系统概览、用户管理、项目管理、容器构建管理、资产仓库、技能仓库、Web Search 配置
• auth
  • 登录态、当前用户、个人 Web Search 设置、个人 Token Usage
• projects
  • 项目列表、项目详情、成员管理
• conversations
  • 会话、消息、分支、定时任务、聊天流
• catalogs
  • skills、actions、agents、runtimes、visualizers、MCP servers
• files
  • 项目文件、文件夹、下载/预览、本地工作区文件
• agents
  • Agent ticket、权限请求、tool change revert
• container
  • 容器状态、镜像选项、事件、构建与日志
• models
  • 项目模型选项与模型管理

常用接口

• 公开 bootstrap 对话
  • GET /api/public/chat/bootstrap
  • POST /api/public/chat/bootstrap
• 公开示例项目
  • GET /api/public/showcase/projects
  • GET /api/public/showcase/projects/{projectId}
  • GET /api/public/showcase/projects/{projectId}/conversations
  • GET /api/public/showcase/projects/{projectId}/conversations/{conversationId}/messages
  • GET /api/public/showcase/projects/{projectId}/files
• 项目聊天
  • POST /api/projects/{projectId}/chat
• 会话与消息
  • GET /api/projects/{projectId}/conversations
  • GET /api/projects/{projectId}/conversations/{conversationId}/messages
• 本地工作区
  • GET /api/projects/{projectId}/agent-workspace
  • POST /api/projects/{projectId}/agent-workspace
  • GET /api/projects/{projectId}/agent-workspace/content
  • GET /api/projects/{projectId}/agent-workspace/download
• Skills / Actions / Agents
  • GET /api/projects/{projectId}/skills
  • GET /api/projects/{projectId}/actions
  • GET /api/projects/{projectId}/agents
• MCP
  • GET /api/projects/{projectId}/mcp/servers
  • GET /api/projects/{projectId}/mcp/servers/{serverId}/tools
• Container
  • GET /api/projects/{projectId}/container/status
  • GET /api/projects/{projectId}/container/options
  • GET /api/projects/{projectId}/container-builds/{buildId}/logs
• Admin
  • GET /api/admin/overview
  • GET /api/admin/users
  • GET /api/admin/projects
  • PATCH /api/admin/projects/{projectId}/showcase

当前范围

当前文档已经覆盖前端 SDK 的绝大部分业务接口，当前重点包括：

• 认证与当前用户
• Admin 后台接口
• 项目与成员管理
• 会话、消息与定时任务
• 聊天流式接口
• 文件、文件夹与本地工作区
• Skills / Actions / Agents / Runtimes / Visualizers
• MCP Servers
• Agent 工单与权限请求
• 容器管理
• 模型管理与项目模型选项

使用说明

• 需要登录的接口使用 Bearer 鉴权
• 在 Swagger 页面右上角点 Authorize，填入当前会话 token
• 流式接口会以 text/event-stream 形式展示
• 下载类接口可能返回二进制内容或 ZIP，而不是 JSON
• 同一个路径在某些场景下既支持 JSON，也支持导出下载，例如 download=1

后续新增前端接口时，应同步更新 OpenAPI registry；如果接口会被外部大模型或自动化 Agent 使用，也应同步更新 LLM 操作手册、Cookbook 或 Agent API Profile。