Skip to content

api_docs.md

Latest commit

 

History

History
1753 lines (1431 loc) · 59.9 KB

api_docs.md

File metadata and controls

1753 lines (1431 loc) · 59.9 KB

Backend API 文档

本文档详细描述了 ADP Backend 的所有 API 接口，包括接口地址、请求方法、参数说明和代码定义位置。

目录

  1. 系统接口
  2. 用户认证接口
  3. 智能体(Agent)接口
  4. 聊天(Chat)接口
  5. 收藏夹(Collection)接口
  6. 知识库(Knowledge Base)接口
  7. 文档(Document)接口
  8. 数据集(Dataset)接口
  9. 任务(Task)接口
  10. 流水线(Pipeline)接口
  11. 模板(Template)接口
  12. 组织(Organization)接口
  13. 系统配置(System Config)接口
  14. OpenAPI 接口
  15. 管理员接口
  16. 会话(Conversation)接口
  17. 第三方接口
  18. LLM 聊天接口

1. 系统接口

1.1 健康检查

  • URL: /health/
  • 方法: GET
  • 描述: 服务健康检查接口
  • 响应: HTTP 200
  • 代码位置: core/urls.py:24

1.2 API 文档

  • Swagger UI: /api/docs/ 或 /api/docs
  • ReDoc: /api/redoc/ 或 /api/redoc
  • OpenAPI Schema: /api/schema/ 或 /api/schema
  • 代码位置: core/urls.py:32-37

2. 用户认证接口

基础路径: /api/v1/

2.1 用户登录

2.2 手机号登录

  • URL: /api/v1/login/phone
  • 方法: POST
  • 描述: 手机号短信验证码登录
  • 请求参数:
    • phone: 手机号
    • code: 短信验证码
  • 代码位置: user/urls.py:27

2.3 发送登录短信验证码

  • URL: /api/v1/login/sms/code
  • 方法: POST
  • 描述: 发送登录用短信验证码
  • 请求参数:
    • phone: 手机号
  • 代码位置: user/urls.py:28

2.4 用户注册

  • URL: /api/v1/register
  • 方法: POST
  • 描述: 邮箱注册
  • 请求参数:
    • email: 邮箱地址
    • password: 密码
    • code: 邮箱验证码
  • 代码位置: user/urls.py:20

2.5 手机号注册

  • URL: /api/v1/register/sms
  • 方法: POST
  • 描述: 手机号短信注册
  • 请求参数:
    • phone: 手机号
    • code: 短信验证码
  • 代码位置: user/urls.py:29

2.6 发送邮箱验证码

  • URL: /api/v1/email/code
  • 方法: POST
  • 描述: 发送邮箱验证码
  • 请求参数:
    • email: 邮箱地址
  • 代码位置: user/urls.py:21

2.7 发送短信验证码

  • URL: /api/v1/sms/code
  • 方法: POST
  • 描述: 发送短信验证码
  • 请求参数:
    • phone: 手机号
  • 代码位置: user/urls.py:30

2.8 发送重置密码邮箱验证码

  • URL: /api/v1/password/reset/code
  • 方法: POST
  • 描述: 发送重置密码用的邮箱验证码
  • 代码位置: user/urls.py:22

2.9 发送重置密码短信验证码

  • URL: /api/v1/password/reset/code/sms
  • 方法: POST
  • 描述: 发送重置密码用的短信验证码
  • 请求参数:
    • phone: 手机号
  • 代码位置: user/urls.py:31

2.10 重置密码（邮箱）

  • URL: /api/v1/password/reset
  • 方法: POST
  • 描述: 通过邮箱验证码重置密码
  • 请求参数:
    • email: 邮箱地址
    • code: 验证码
    • new_password: 新密码
  • 代码位置: user/urls.py:23

2.11 重置密码（短信）

  • URL: /api/v1/password/reset/sms
  • 方法: POST
  • 描述: 通过短信验证码重置密码
  • 请求参数:
    • phone: 手机号
    • code: 验证码
    • new_password: 新密码
  • 代码位置: user/urls.py:32

2.12 Token 刷新

  • URL: /api/v1/refresh
  • 方法: POST
  • 描述: 刷新访问令牌
  • 代码位置: user/urls.py:18

2.13 用户登出

  • URL: /api/v1/logout
  • 方法: POST
  • 描述: 用户登出
  • 代码位置: user/urls.py:19

2.14 获取用户信息

2.15 同步用户信息

2.16 微信二维码登录

生成二维码

  • URL: /api/v1/wechat/qr/generate
  • 方法: GET
  • 描述: 生成微信登录二维码
  • 代码位置: user/urls.py:35

检查二维码状态

  • URL: /api/v1/wechat/qr/status
  • 方法: GET
  • 描述: 检查微信登录二维码扫描状态
  • 代码位置: user/urls.py:36

微信回调

  • URL: /api/v1/wechat/callback
  • 方法: GET
  • 描述: 微信 OAuth 回调接口
  • 代码位置: user/urls.py:37

2.17 GitHub OAuth 登录

生成登录链接

  • URL: /api/v1/github/auth/generate
  • 方法: GET
  • 描述: 生成 GitHub 授权登录链接
  • 代码位置: user/urls.py:40

检查登录状态

  • URL: /api/v1/github/auth/status
  • 方法: GET
  • 描述: 检查 GitHub 登录状态
  • 代码位置: user/urls.py:41

GitHub 回调

  • URL: /api/v1/github/callback
  • 方法: GET
  • 描述: GitHub OAuth 回调接口
  • 代码位置: user/urls.py:42

2.18 邀请码管理

获取邀请码列表

创建邀请码

  • URL: /api/v1/invite-codes
  • 方法: POST
  • 描述: 创建新的邀请码（管理员权限）
  • 请求参数:
    • code: 邀请码
    • description: 描述（可选）
    • max_uses: 最大使用次数（默认 1）
    • expires_at: 过期时间（可选）
  • 代码位置: user/urls.py:45, user/views.py:153

更新邀请码

  • URL: /api/v1/invite-codes/<int:invite_code_id>
  • 方法: PUT
  • 描述: 更新邀请码信息（管理员权限）
  • 代码位置: user/urls.py:46, user/views.py:208

删除邀请码

2.19 发送反馈

  • URL: /api/v1/feedback
  • 方法: POST
  • 描述: 发送用户反馈
  • 代码位置: user/urls.py:24

3. 智能体(Agent)接口

基础路径: /api/v1/

3.1 智能体列表/详情

  • URL: /api/v1/agents
  • URL: /api/v1/agents/<str:agent_id>
  • 方法: GET
  • 描述: 获取智能体列表或指定智能体详情
  • 查询参数:
    • page: 页码（可选）
    • page_size: 每页数量（可选）
    • list_type: 列表类型（可选）
    • keyword: 搜索关键词（可选）
    • source: 来源，如 share（可选）
  • 代码位置: agent/urls.py:15-16, agent/views.py:154

3.2 创建智能体

  • URL: /api/v1/agents
  • 方法: POST
  • 描述: 创建新的智能体
  • 请求参数:
    • title: 标题
    • description: 描述（可选）
    • collection_and_kbs: 知识库集合（可选）
    • tools: 工具列表（可选）
    • type: 类型（可选）
  • 代码位置: agent/urls.py:15, agent/views.py:191

3.3 更新智能体

3.4 删除智能体

3.5 订阅/取消订阅智能体

  • URL: /api/v1/agents/<str:agent_id>/subscribe/<int:action>
  • 方法: POST
  • 描述: 订阅或取消订阅智能体
  • 参数:
    • action: 1 表示订阅，0 表示取消订阅
  • 代码位置: agent/urls.py:17, agent/views.py:360

3.6 智能体工具管理

创建工具

  • URL: /api/v1/agents/tools
  • 方法: POST
  • 描述: 为智能体创建新工具
  • 请求参数:
    • agent_id: 智能体ID（可选）
    • name: 工具名称
    • url: 工具URL
    • openapi_json_path: OpenAPI JSON 路径
    • endpoints: 端点列表
  • 代码位置: agent/urls.py:7, agent/views.py:262

更新工具

删除工具

3.7 获取收藏夹和知识库

3.8 获取收藏夹和知识库文档

3.9 智能体分享提示

  • URL: /api/v1/agents/share/tips
  • URL: /api/v1/agents/share/tips/<str:status>
  • 方法: POST
  • 描述: 设置智能体分享提示状态
  • 代码位置: agent/urls.py:12-13, agent/views.py:414

4. 聊天(Chat)接口

基础路径: /api/v1/

4.1 发送聊天消息

  • URL: /api/v1/chat
  • 方法: POST
  • 描述: 向智能体发送消息并获取流式响应
  • 请求参数:
    • agent_id: 智能体ID（可选）
    • conversation_id: 会话ID（可选）
    • question: 问题内容
    • collection_and_kbs: 知识库范围（可选）
  • 响应: text/event-stream 流式响应
  • 代码位置: chat/urls.py:8, chat/views.py:74

4.2 会话管理

获取会话列表

  • URL: /api/v1/chat/conversations
  • 方法: GET
  • 描述: 获取用户的会话列表
  • 查询参数:
    • type: 类型，如 list
    • page_size: 每页数量
    • page_num: 页码
  • 代码位置: chat/urls.py:10, chat/views.py:105

获取会话菜单

  • URL: /api/v1/chat/conversations/menu
  • 方法: GET
  • 描述: 获取会话菜单列表
  • 查询参数:
    • list_type: 列表类型
  • 代码位置: chat/urls.py:11, chat/views.py:174

获取会话详情

创建会话

  • URL: /api/v1/chat/conversations
  • 方法: POST
  • 描述: 创建新会话
  • 请求参数:
    • agent_id: 智能体ID（可选）
    • share_id: 分享ID（可选）
    • title: 会话标题（可选）
  • 代码位置: chat/urls.py:10, chat/views.py:140

更新会话

删除会话

4.3 获取会话问题列表

  • URL: /api/v1/chat/conversations/<str:conversation_id>/questions
  • 方法: GET
  • 描述: 获取会话中的问题列表
  • 查询参数:
    • page_num: 页码
    • page_size: 每页数量
  • 代码位置: chat/urls.py:14, chat/views.py:188

4.4 更新问题答案

4.5 会话分享

创建分享

  • URL: /api/v1/chat/share
  • 方法: POST
  • 描述: 创建会话分享
  • 请求参数:
    • conversation_id: 会话ID
    • question_ids: 问题ID列表（可选）
  • 代码位置: chat/urls.py:18, chat/views.py:250

获取分享详情

4.6 获取文档总数

4.7 获取可引用智能体

5. 收藏夹(Collection)接口

基础路径: /api/v1/

5.1 获取收藏夹列表/详情

  • URL: /api/v1/collections
  • URL: /api/v1/collections/<str:collection_id>
  • 方法: GET
  • 描述: 获取收藏夹列表或指定收藏夹详情
  • 查询参数:
    • list_type: 列表类型（可选）
    • page_size: 每页数量（可选）
    • page_num: 页码（可选）
  • 代码位置: collection/urls.py:8, collection/views.py:139

5.2 创建收藏夹

5.3 更新收藏夹

5.4 删除收藏夹

5.5 收藏夹文档管理

获取收藏夹文档

添加文档到收藏夹

从收藏夹删除文档

5.6 获取公开智能体

6. 知识库(Knowledge Base)接口

基础路径: /api/v1/

6.1 获取知识库列表/详情

  • URL: /api/v1/knowledge-base
  • URL: /api/v1/knowledge-base/<str:kb_id>
  • 方法: GET
  • 描述: 获取知识库列表或指定知识库详情
  • 查询参数:
    • page: 页码（可选）
    • page_size: 每页数量（可选）
    • list_type: 列表类型（可选）
    • group_id: 分组ID（可选）
  • 代码位置: knowledgebase/urls.py:7, knowledgebase/views.py:151

6.2 创建知识库

6.3 更新知识库

6.4 删除知识库

6.5 搜索知识库

  • URL: /api/v1/knowledge-base/search
  • 方法: POST
  • 描述: 在知识库中搜索内容
  • 请求参数:
    • kb_ids: 知识库ID列表（可选）
    • keyword: 搜索关键词
    • group_id: 分组ID（可选）
    • page_size: 每页数量（可选）
    • page_num: 页码（可选）
  • 代码位置: knowledgebase/urls.py:8, knowledgebase/views.py:263

6.6 移动知识库文档

6.7 刷新知识库文档

6.8 知识库文档管理

获取文档列表

删除文档

6.9 知识库文件管理

获取文件列表

上传文件

删除文件

6.10 搜索历史

获取搜索历史

删除搜索历史

7. 文档(Document)接口

基础路径: /api/v1/

7.1 文档管理

获取文档列表

  • URL: /api/v1/documents
  • 方法: GET
  • 描述: 获取文档列表
  • 代码位置: document/urls.py:6

获取文档详情

  • URL: /api/v1/documents/<str:kb_type>/<str:kb_id>/<int:doc_id>
  • 方法: GET
  • 描述: 获取指定文档详情
  • 代码位置: document/urls.py:7

删除文档

  • URL: /api/v1/documents/<str:kb_type>/<str:kb_id>/<int:doc_id>
  • 方法: DELETE
  • 描述: 删除指定文档
  • 代码位置: document/urls.py:7

7.2 文档搜索

  • URL: /api/v1/documents/search
  • 方法: GET/POST
  • 描述: 搜索文档
  • 代码位置: document/urls.py:8

7.3 获取公开智能体

  • URL: /api/v1/documents/pub-agents
  • 方法: GET
  • 描述: 获取与文档相关的公开智能体
  • 代码位置: document/urls.py:9

7.4 生成预签名URL

  • URL: /api/v1/documents/presigned-url
  • 方法: POST
  • 描述: 生成文档预签名URL
  • 代码位置: document/urls.py:10

7.5 获取文档URL

  • URL: /api/v1/documents/<str:kb_type>/<str:kb_id>/<int:doc_id>/url
  • 方法: GET
  • 描述: 获取文档访问URL
  • 代码位置: document/urls.py:11

7.6 获取引用格式

  • URL: /api/v1/documents/<str:kb_type>/<str:kb_id>/<int:doc_id>/references/formats
  • 方法: GET
  • 描述: 获取文档引用格式
  • 代码位置: document/urls.py:12

7.7 文档片段(Chunk)管理

获取片段列表

  • URL: /api/v1/chunks
  • 方法: GET
  • 描述: 获取文档片段列表
  • 代码位置: document/urls.py:15

批量操作片段

  • URL: /api/v1/chunks/batch
  • 方法: POST/PUT/DELETE
  • 描述: 批量操作文档片段
  • 代码位置: document/urls.py:16

获取片段详情

  • URL: /api/v1/chunks/<str:kb_id>/<int:doc_id>/<int:chunk_id>
  • 方法: GET
  • 描述: 获取指定文档片段详情
  • 代码位置: document/urls.py:17

删除片段

  • URL: /api/v1/chunks/<str:kb_id>/<int:doc_id>/<int:chunk_id>
  • 方法: DELETE
  • 描述: 删除指定文档片段
  • 代码位置: document/urls.py:17

搜索片段

  • URL: /api/v1/chunks/search
  • 方法: GET/POST
  • 描述: 搜索文档片段
  • 代码位置: document/urls.py:18

8. 数据集(Dataset)接口

基础路径: /api/v2/ 和 /api/v1/

8.1 V2 版本接口

数据集管理（ViewSet）

文件管理（ViewSet）

对象存储管理（ViewSet）

8.2 V1 版本接口

获取数据集列表/详情

  • URL: /api/v1/dataset
  • URL: /api/v1/dataset/<str:dataset_id>
  • 方法: GET
  • 描述: 获取数据集列表或详情
  • 代码位置: apps/dataset/urls_v1.py:8-9

创建数据集

更新数据集

删除数据集

搜索历史

删除搜索历史

  • URL: /api/v1/dataset/search/history/<int:index>
  • 方法: DELETE
  • 描述: 删除指定搜索历史
  • 代码位置: apps/dataset/urls_v1.py:12

移动数据集文件

获取数据集文件

  • URL: /api/v1/dataset/<str:dataset_id>/files
  • 方法: GET
  • 描述: 获取数据集文件列表
  • 代码位置: apps/dataset/urls_v1.py:15

获取文件详情

  • URL: /api/v1/dataset/<str:dataset_id>/files/<str:file_id>
  • 方法: GET
  • 描述: 获取文件详情
  • 代码位置: apps/dataset/urls_v1.py:16

生成预签名URL

  • URL: /api/v1/presigned-url
  • URL: /api/v1/dataset/file/url
  • 方法: POST
  • 描述: 生成文件预签名URL
  • 代码位置: apps/dataset/urls_v1.py:17-18

第三方数据集列表

第三方数据集详情

  • URL: /api/v1/third-party/detail/<str:dataset_name>
  • 方法: GET
  • 描述: 获取第三方数据集详情
  • 代码位置: apps/dataset/urls_v1.py:22

第三方数据集文件

  • URL: /api/v1/third-party/files/<str:dataset_name>
  • 方法: GET
  • 描述: 获取第三方数据集文件列表
  • 代码位置: apps/dataset/urls_v1.py:23

9. 任务(Task)接口

基础路径: /api/v1/

9.1 任务管理

获取任务列表/详情

  • URL: /api/v1/task
  • URL: /api/v1/task/<str:id>
  • 方法: GET
  • 描述: 获取任务列表或详情
  • 查询参数:
    • page: 页码
    • page_size: 每页数量
    • status: 状态筛选
    • keyword: 关键词搜索
  • 代码位置: task/urls.py:11, task/views/__init__.py:75

创建任务

  • URL: /api/v1/task
  • 方法: POST
  • 描述: 创建新任务
  • 请求参数:
    • name: 任务名称
    • description: 描述（可选）
    • template_id: 模板ID（可选）
    • dataset_id: 数据集ID（可选）
  • 代码位置: task/urls.py:11, task/views/__init__.py:98

更新任务

删除任务

9.2 从模板创建任务

  • URL: /api/v1/task/create-from-template
  • 方法: POST
  • 描述: 从模板创建并启动任务
  • 请求参数:
    • template_id: 模板ID
    • name: 任务名称
    • description: 描述
    • dataset_id: 数据集ID（可选）
  • 代码位置: task/urls.py:13, task/views/__init__.py:221

9.3 异步从模板创建任务

9.4 生成 Pipeline URL

9.5 任务状态查询

9.6 任务操作

启动任务

停止任务

恢复任务

重启任务

9.7 设置任务优先级

  • URL: /api/v1/task/<str:task_id>/priority
  • 方法: POST
  • 描述: 设置任务优先级
  • 请求参数:
    • priority: 优先级值（1-100，数字越小优先级越高）
  • 代码位置: task/urls.py:26, task/views/__init__.py:449

9.8 任务实时监听

监听新消息

Debug 模式监听

9.9 搜索历史

获取搜索历史

删除搜索历史

9.10 流水线结果查询

9.11 父子流水线子任务

9.12 下载流水线结果

9.13 流水线评估

  • URL: /api/v1/pipelines/evaluate
  • 方法: POST
  • 描述: 流水线多维度打分
  • 请求参数:
    • scene: 评估场景
    • parent_pipeline_id: 父流水线ID（可选）
    • pipeline_id: 流水线ID（可选）
    • stage: 阶段（可选）
    • input_key: 输入键（可选）
    • custom_dimensions: 自定义维度（可选）
    • samples: 样本数据（可选）
  • 代码位置: task/urls.py:39, task/views/__init__.py:651

9.14 回调接口

更新数据回调

更新周期状态回调

10. 流水线(Pipeline)接口

基础路径: /api/v2/

10.1 任务记录统计（ViewSet）

10.2 操作符管理（ViewSet）

10.3 会话管理（ViewSet）

10.4 创建并启动任务

10.5 获取记录详情（简化）

  • URL: /api/v2/task/record_detail_simple
  • 方法: GET
  • 描述: 获取简化的任务记录详情
  • 代码位置: apps/pipelines/urls.py:22

10.6 Prefect 回调

  • URL: /api/v2/task/prefect_callback
  • URL: /api/v2/prefect/callback
  • 方法: POST
  • 描述: Prefect 任务系统回调
  • 代码位置: apps/pipelines/urls.py:24-25

10.7 任务记录重试

10.8 任务记录播放

  • URL: /api/v2/task/record/<str:rid>/play
  • 方法: POST
  • 描述: 播放/执行任务记录
  • 代码位置: apps/pipelines/urls.py:28

10.9 查询流水线结果

  • URL: /api/v2/pipelines/results/query
  • 方法: POST
  • 描述: 查询流水线执行结果
  • 代码位置: apps/pipelines/urls.py:30

11. 模板(Template)接口

基础路径: /api/v1/

11.1 获取模板列表/详情

  • URL: /api/v1/templates
  • URL: /api/v1/templates/<int:config_id>
  • 方法: GET
  • 描述: 获取模板列表或详情
  • 查询参数:
    • keyword: 关键词搜索
    • page: 页码
    • page_size: 每页数量
  • 代码位置: template/urls.py:7-8, template/views.py:105

11.2 创建模板

  • URL: /api/v1/templates
  • 方法: POST
  • 描述: 创建新模板
  • 请求参数:
    • name: 模板名称
    • description: 描述
    • pipeline_config_a: Pipeline配置A
    • pipeline_config_v: Pipeline配置V
  • 代码位置: template/urls.py:7, template/views.py:122

11.3 更新模板

11.4 删除模板

11.5 搜索历史

获取搜索历史

  • URL: /api/v1/templates/search/history
  • 方法: GET
  • 描述: 获取模板搜索历史
  • 代码位置: template/views.py:32

删除搜索历史

  • URL: /api/v1/templates/search/history/<int:index>
  • 方法: DELETE
  • 描述: 删除指定搜索历史
  • 代码位置: template/views.py:43

12. 组织(Organization)接口

基础路径: /api/v1/

12.1 创建组织

12.2 获取组织列表

  • URL: /api/v1/organization/list
  • 方法: GET
  • 描述: 获取组织列表
  • 查询参数:
    • page: 页码
    • page_size: 每页数量
    • search: 搜索关键词
    • created_by: 创建者筛选
  • 代码位置: organization/urls.py:7, organization/views.py:220

12.3 获取我的组织

12.4 获取组织详情

12.5 更新组织

12.6 删除组织

12.7 重新生成组织令牌

12.8 组织成员管理

获取成员列表

添加成员

移除成员

13. 系统配置(System Config)接口

13.1 V1 版本接口

基础路径: /api/v1/

获取系统配置

  • URL: /api/v1/system-config
  • URL: /api/v1/system-config/<str:config_id>
  • 方法: GET
  • 描述: 获取系统配置列表或详情
  • 代码位置: systemconfig/urls.py:8-10

创建系统配置

更新系统配置

  • URL: /api/v1/system-config/<str:config_id>
  • 方法: PUT
  • 描述: 更新系统配置
  • 代码位置: systemconfig/urls.py:10

搜索系统配置

  • URL: /api/v1/system-config/search
  • 方法: GET
  • 描述: 搜索系统配置
  • 代码位置: systemconfig/urls.py:8

13.2 V2 版本接口（ViewSet）

基础路径: /api/v2/

系统配置管理

外部服务管理

14. OpenAPI 接口

基础路径: /api/v1/

14.1 API Key 管理

获取 API Key 列表

  • URL: /api/v1/openapi/apikey
  • 方法: GET
  • 描述: 获取用户的 API Key 列表
  • 查询参数:
    • page_size: 每页数量
    • page_num: 页码
    • is_all: 是否获取全部
    • is_used: 是否已使用
  • 代码位置: openapi/urls.py:8, openapi/views.py:39

创建 API Key

更新 API Key

删除 API Key

14.2 使用情况统计

14.3 从模板创建 Dataflow 任务

  • URL: /api/v1/openapi/v1/dataflow/tasks/create-from-template
  • 方法: POST
  • 描述: 通过签名从模板创建任务
  • 查询参数:
    • signature: Base64 编码的签名数据
  • 代码位置: openapi/urls.py:12, openapi/views.py:82

14.4 安全 API Key 管理

基础路径: /api/v1/openapi/

获取安全 API Key 列表

创建安全 API Key

获取安全 API Key 详情

  • URL: /api/v1/openapi/keys/secure/<str:api_key_id>
  • 方法: GET
  • 描述: 获取指定安全 API Key 详情
  • 代码位置: openapi/urls_secure.py:12

更新安全 API Key

  • URL: /api/v1/openapi/keys/secure/<str:api_key_id>
  • 方法: PUT
  • 描述: 更新安全 API Key
  • 代码位置: openapi/urls_secure.py:13

删除安全 API Key

  • URL: /api/v1/openapi/keys/secure/<str:api_key_id>
  • 方法: DELETE
  • 描述: 删除安全 API Key
  • 代码位置: openapi/urls_secure.py:14

轮换 API Key

  • URL: /api/v1/openapi/keys/secure/<str:api_key_id>/rotate
  • 方法: POST
  • 描述: 轮换 API Key
  • 代码位置: openapi/urls_secure.py:17

获取使用日志

  • URL: /api/v1/openapi/keys/secure/<str:api_key_id>/logs
  • 方法: GET
  • 描述: 获取 API Key 使用日志
  • 代码位置: openapi/urls_secure.py:18

获取统计数据

  • URL: /api/v1/openapi/keys/secure/stats
  • 方法: GET
  • 描述: 获取 API Key 使用统计
  • 代码位置: openapi/urls_secure.py:21

验证 API Key 强度

  • URL: /api/v1/openapi/keys/secure/validate
  • 方法: POST
  • 描述: 验证 API Key 强度
  • 代码位置: openapi/urls_secure.py:22

批量删除

  • URL: /api/v1/openapi/keys/secure/bulk-delete
  • 方法: POST
  • 描述: 批量删除 API Key
  • 代码位置: openapi/urls_secure.py:25

15. 管理员接口

基础路径: /api/admin/

15.1 智能体管理

获取智能体详情

删除智能体

15.2 智能体发布管理

获取发布列表

发布智能体

取消发布

更新发布顺序

15.3 知识库管理

获取知识库详情

15.4 知识库发布管理

获取发布列表

发布知识库

取消发布

更新发布顺序

15.5 用户权限管理

设置超级用户

设置管理员

设置用户激活状态

15.6 用户列表

15.7 全局配置

16. 会话(Conversation)接口

基础路径: /api/v1/

16.1 创建会话

  • URL: /api/v1/df-conversation/create
  • 方法: POST
  • 描述: 创建新会话
  • 请求参数:
    • title: 会话标题（可选）
    • dataset_id: 数据集ID（可选）
  • 代码位置: df_conversation/urls.py:21

16.2 获取会话列表

  • URL: /api/v1/df-conversation/list
  • 方法: GET
  • 描述: 获取用户的所有会话
  • 查询参数:
    • page: 页码
    • page_size: 每页数量
  • 代码位置: df_conversation/urls.py:24

16.3 获取会话详情/删除会话

  • URL: /api/v1/df-conversation/<uuid:conversation_id>
  • 方法: GET, DELETE
  • 描述: 获取会话详情或删除会话
  • 代码位置: df_conversation/urls.py:27

17. 第三方接口

基础路径: /api/v1/

17.1 KPS 接口

查询数据集

  • URL: /api/v1/third-party/kps/query-dataset
  • 方法: GET/POST
  • 描述: 查询 KPS 数据集
  • 代码位置: third_party/urls.py:28

回调接口

  • URL: /api/v1/third-party/kps/callback
  • 方法: POST
  • 描述: KPS 回调处理
  • 代码位置: third_party/urls.py:29

额外导入

  • URL: /api/v1/third-party/kps/import
  • 方法: POST
  • 描述: KPS 额外数据导入
  • 代码位置: third_party/urls.py:30

17.2 测试接口

  • URL: /api/v1/third-party/test
  • 方法: GET
  • 描述: 第三方测试接口
  • 代码位置: third_party/urls.py:31

18. LLM 聊天接口

基础路径: /llm_chat/

18.1 聊天完成

  • URL: /llm_chat/v1/chat/completions
  • 方法: POST
  • 描述: LLM 聊天完成接口（代理转发）
  • 请求参数: 兼容 OpenAI API 格式
  • 代码位置: llm_chat/urls.py:5

【不完善】19. 训练(Train)接口

基础路径: /api/v1/

19.1 训练服务代理

  • URL: /api/v1/train/
  • URL: /api/v1/train/<path:path>
  • 方法: ALL
  • 描述: 训练服务代理转发
  • 代码位置: train/urls.py:7-8

核心配置

主 URL 配置

  • 文件位置: core/urls.py
  • 描述: 所有 API 路由的主入口配置

主要模块 URL 映射

模块 URL 前缀 URL 配置文件
User /api/v1/ user/urls.py
Agent /api/v1/ agent/urls.py
Chat /api/v1/ chat/urls.py
Collection /api/v1/ collection/urls.py
Knowledge Base /api/v1/ knowledgebase/urls.py
Document /api/v1/ document/urls.py
Dataset V1 /api/v1/ apps/dataset/urls_v1.py
Dataset V2 /api/v2/ apps/dataset/urls.py
Task /api/v1/ task/urls.py
Pipeline /api/v2/ apps/pipelines/urls.py
Template /api/v1/ template/urls.py
Organization /api/v1/ organization/urls.py
System Config V1 /api/v1/ systemconfig/urls.py
System Config V2 /api/v2/ apps/system/urls.py
OpenAPI /api/v1/ openapi/urls.py
Custom Admin /api/admin/ customadmin/urls.py
Conversation /api/v1/ df_conversation/urls.py
Third Party /api/v1/ third_party/urls.py
LLM Chat /llm_chat/ llm_chat/urls.py
Train /api/v1/ train/urls.py

认证说明

JWT Token 认证

大多数 API 接口需要 JWT Token 认证。在请求头中添加：

Authorization: Bearer <your_jwt_token>

权限等级

  1. 普通用户: 只能访问自己的资源
  2. 管理员(is_staff): 可以访问大部分管理接口
  3. 超级用户(is_superuser): 拥有所有权限

响应格式

成功响应

{
  "code": 0,
  "msg": "success",
  "data": {}
}

错误响应

{
  "code": 100001,
  "msg": "错误信息",
  "data": {}
}

常见错误码

错误码 说明
0 成功
100000 通用错误
100001 参数错误/验证失败
100002 资源不存在
100003 无权限
510888 任务操作错误
150001 API Key 数量限制
190001 参数错误：资源不存在

分页说明

列表接口默认支持分页，返回格式：

{
  "code": 0,
  "msg": "success",
  "data": {
    "list": [],
    "total": 100,
    "page": 1,
    "page_size": 10,
    "total_pages": 10
  }
}

流式响应

聊天接口使用 SSE (Server-Sent Events) 流式响应：

data: {"content_type": "on_message", "content": "Hello"}

data: {"content_type": "on_message", "content": " World"}

data: {"content_type": "on_complete"}

文档生成时间: 2026-02-23 版本: v1.1