上传文档

上传一个或多个文档到 RAG 知识库。服务会保存文件、按参数切分文本，并写入向量集合。

Try It

POST/documents/uploadhttps://api-platform.ope.ai

认证

使用 Bearer Token 认证。

• Header：Authorization: Bearer <token>
• 示例：Authorization: Bearer sk-xxxxxx

请求体（multipart/form-data）

字段	类型	必填	说明	默认值 / 范围
model	string	是	用于文档向量化的 Embedding 模型名称	例如 bge-m3
files	file[]	是	待上传的文档文件，支持同字段多文件上传	-
chunk_size	integer	否	文档分块大小	默认 500
chunk_overlap	integer	否	相邻分块的重叠字符数，用于保持上下文连续性	默认 50
separators	string	否	自定义分隔符	默认分隔策略

默认限制

限制项	默认限制	说明
文档数量	单账号最多 100 个文档	包含当前保留在知识库中的文档
文档总容量	单账号累计文档大小最多 200 MB	超出限制时需要删除部分文档、压缩/拆分文档，或申请更高配额

如需更高文档数量、更大文件或专属知识库方案，请联系我们。

请求示例

cURL

curl -X POST "https://api-platform.ope.ai/documents/upload" \
  -H "Authorization: Bearer $OPEAI_API_KEY" \
  -F "model=bge-m3" \
  -F "chunk_size=500" \
  -F "chunk_overlap=50" \
  -F "files=@./handbook.pdf" \
  -F "files=@./faq.docx"

JavaScript

const form = new FormData();
form.append("model", "bge-m3");
form.append("chunk_size", "500");
form.append("chunk_overlap", "50");
form.append("files", fileInput.files[0]);

const res = await fetch("https://api-platform.ope.ai/documents/upload", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OPEAI_API_KEY}`,
  },
  body: form,
});

console.log(await res.json());

响应示例

{
  "status": "success",
  "uploaded": [
    {
      "doc_id": "doc_1",
      "filename": "handbook.pdf",
      "status": "success"
    }
  ]
}

错误响应

状态码	场景	说明
401	鉴权失败	API Key 缺失、无效或权限不足
422	参数校验失败	缺少文件、模型或表单字段格式不正确
500	上传处理失败	文件保存、文本分块、向量入库或数据库操作失败