下载文档

下载指定的原始文档文件。通常先通过 文档列表 获取 filepath 和 filename，再调用该接口。

Try It

GET/documents/download_document?doc_file_path=%2Fdata%2Fuploads%2Ftenant_1%2Fhandbook.pdf&filename=handbook.pdfhttps://api-platform.ope.ai

认证

使用 Bearer Token 认证。

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

查询参数

字段	类型	必填	说明	默认值 / 范围
doc_file_path	string	是	文档文件路径，建议使用文档列表返回的 filepath	需要 URL 编码
filename	string	是	下载时展示的文件名	-

请求示例

cURL

curl -L "https://api-platform.ope.ai/documents/download_document?doc_file_path=%2Fdata%2Fuploads%2Ftenant_1%2Fhandbook.pdf&filename=handbook.pdf" \
  -H "Authorization: Bearer $OPEAI_API_KEY" \
  -o handbook.pdf

JavaScript

const url = new URL("https://api-platform.ope.ai/documents/download_document");
url.searchParams.set("doc_file_path", "/data/uploads/tenant_1/handbook.pdf");
url.searchParams.set("filename", "handbook.pdf");

const res = await fetch(url, {
  headers: {
    Authorization: `Bearer ${process.env.OPEAI_API_KEY}`,
  },
});

const blob = await res.blob();
console.log(blob.size);

响应

成功时返回文件二进制内容。失败时返回错误信息。

错误响应

状态码	场景	说明
401	鉴权失败	API Key 缺失、无效或权限不足
422	参数校验失败	doc_file_path 或 filename 缺失
404	文件不存在	文件路径无效或文件已被删除
500	下载失败	文件无法访问或服务端处理失败