RagApp_API
  1. 文档管理 /documents
RagApp_API
  • 概述
  • 息壤大模型名称列表
  • 数据库连接信息
  • MinerU的APIToken仅14天
  • 用户(弃用)
    • 注册
      POST
    • 登录
      POST
    • 验证邮箱
      GET
    • 重发验证邮件
      POST
    • 获取当前用户信息
      GET
    • 测试用户登录状态
      GET
  • 开发测试接口
    • 简单对话
      POST
    • 简单对话+上下文
      POST
    • 网络延迟测试
      POST
  • RAG 聊天
    • [说明] 关于User-ID
    • 文档管理 /documents
      • [说明] 文件上传指南
      • 获取预签名上传 URL
        POST
      • 确认文件上传
        POST
      • (传统)上传文档
        POST
      • 查询文档处理状态
        GET
      • 重新触发索引
        POST
      • 获取文档列表
        GET
      • 获取文档详情
        GET
      • 删除文档
        DELETE
    • 对话 /rag
      • [说明] 完整使用流程示例
      • 单轮 RAG 查询
      • 多轮对话 RAG
      • (dev) 对话
  1. 文档管理 /documents

获取预签名上传 URL

POST
/documents/presign
获取 OSS 预签名上传 URL,用于前端直传文件到 OSS(绕过 Vercel Functions 4.5MB 请求体限制)
之后,应该调用/documents/{document_id}/confirm这个api来确认上传,触发索引。
此接口被调用后,会在数据库里的documents表插入关于这个文档的新记录,status字段为pending

请求参数

Header 参数

Body 参数application/json必填

示例
{
    "filename": "document.pdf",
    "file_size": 10485760,
    "content_type": "application/pdf"
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/documents/presign' \
--header 'X-User-ID: {{X-User-ID}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "filename": "document.pdf",
    "file_size": 10485760,
    "content_type": "application/pdf"
}'

返回响应

🟢200成功
application/json
Body

示例
{
    "document_id": 1,
    "upload_url": "https://bucket.oss-cn-xxx.aliyuncs.com/users/123/documents/1/document.pdf?OSSAccessKeyId=xxx&Expires=xxx&Signature=xxx",
    "oss_path": "users/123/documents/1/document.pdf",
    "expires_in": 600
}
🟠400文件类型错误
🟠400文件过大
🟠422422 参数错误
修改于 2025-12-04 05:17:20
上一页
[说明] 文件上传指南
下一页
确认文件上传
Built with