Skip to content

API 概览

TrustRAG 后端提供 RESTful API,桌面模式和服务器模式对外暴露相同的接口。

基本信息

项目
协议HTTP
格式JSON
默认端口3000(后端)/ 8080(Web UI)
认证Bearer Token

API 模块

模块路径前缀说明
认证/api/auth登录、Token 管理
工作区/api/workspaces工作区 CRUD
文档/api/workspaces/:id/documents文档上传与管理
对话/api/workspaces/:id/chats对话与消息
引用/api/citations引用查询与审核

通用响应格式

成功

json
{
  "data": { ... },
  "message": "success"
}

错误

json
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Workspace not found"
  }
}

HTTP 状态码

状态码含义
200成功
201创建成功
400请求参数错误
401未认证
404资源不存在
500服务器内部错误

Released under the Apache 2.0 License.