【RAGFlow代码详解-25】HTTP 接口

认证

所有 HTTP API 端点都需要使用 API 密钥进行持有者令牌身份验证。身份验证机制在
api/utils/api_utils.py 290-306 中
通过 token_required 装饰器实现，该装饰器根据存储在数据库中的 APIToken 模型验证令牌。

@token_required
def endpoint_function(tenant_id):
    # tenant_id is automatically injected after successful authentication

API 密钥在 Authorization 标头中传递：

Authorization: Bearer <YOUR_API_KEY>

API 架构概述

HTTP API 是使用具有模块化蓝图结构的 Flask 构建的。每个主要功能区域都作为 api/apps/sdk/ 下的单独应用程序模块实现。

基于蓝图的 Flask 架构

核心 API 类别

数据集管理

数据集终结点处理知识库生命周期作，包括创建、更新和删除。主要实现位于
api/apps/sdk/dataset.py

关键端点：

• POST /api/v1/datasets - 创建数据集（ dataset.py 56 ）
• GET /api/v1/datasets - 列出数据集 （ dataset.py 381 ）
• PUT /api/v1/datasets/{dataset_id} - 更新数据集 （ dataset.py 254 ）
• DELETE /api/v1/datasets - 删除数据集 （ dataset.py 158 ）
  GET /api/v1/datasets/{dataset_id}/knowledge_graph - 获取数据集的知识图谱 （ dataset.py 476 ）
  DELETE /api/v1/datasets/{dataset_id}/knowledge_graph - 删除数据集的知识图谱 （ dataset.py 516 ）

数据集创建过程通过
api/utils/api_utils.py 479-529 验证
verify_embedding_availability() 嵌入模型，并通过 get_parser_config（） api/utils/api_utils.py 352-394 应用默认解析器配置

文档管理

文档端点管理数据集中的文件上传、处理和检索。实现跨度
api/apps/sdk/doc.py 69-680

关键端点：

• POST /api/v1/datasets/{dataset_id}/documents