Skip to main content
GET
下载文件

授权

Authorization
string
header
必填

每个请求都通过 API Key 认证:Authorization: Bearer {API_KEY}。应用接口使用应用 API Key,知识库接口使用知识库 API Key(快速开始)。

API Key 应保存在服务端,切勿嵌入客户端代码。缺失或无效的 Key 会返回 HTTP 401(unauthorized)。

路径参数

file_id
string<uuid>
必填

要下载的文件 ID,有两个来源:上传文件 响应中的 id,以及 获取会话历史消息 返回的消息里 message_files 各项的 upload_file_id。工具生成的文件需要带上 kind=tool。

查询参数

user
string
必填

终端用户标识,由你的应用定义,需在应用内唯一。必须与拥有该文件的 user 一致。参见 终端用户身份。

Required string length: 1 - 255
as_attachment
boolean
默认值:false

为 true 时,文件以附件形式下载,而不是在浏览器中内联渲染。

kind
enum<string>
默认值:upload

文件来源。消息载荷中返回的 URL 已带上正确的值,只有自行拼接 URL 时才需要手动设置。

可用选项:
upload,
tool

响应

文件的原始内容。Content-Type 为文件自身的 MIME 类型。当 as_attachment 为 true 时,响应改为 application/octet-stream,并带上 Content-Disposition: attachment。HTML 文件无论 as_attachment 取什么值,都以下载方式返回。

The response is of type file.