助手
扣子 AI 帮助与支持
你好,我是 扣子 文档问答助手 🎉 你在阅读当前文档的过程中,无论对文档概念的解释,还是文档内容方面的疑问,都可以随时向我提问,我会全力为你解答
推荐问题
如何快速了解这个空间的核心内容?
有哪些近期更新的重点文档?
我应该从哪些文档开始阅读?
文档反馈
低代码项目
快速开始
智能体
工作流
应用
资源
发布
模型
多人协作
开发工具
Coze CLI
API 参考
鉴权
智能体和应用
工作空间
文件夹
企业/组织
会话与消息
对话
工作流
智能音视频
知识库
数据库
插件
变量
渠道
用量限额
账单与权益
回调
API 教程
SDK 参考
音视频
推广与变现

上传文件

更新于: 2026-06-25 19:29:14

调用接口上传文件到扣子编程。

接口说明

消息中无法直接使用本地文件,创建消息或对话前,需要先调用此接口上传本地文件到扣子编程。上传文件后,你可以在消息中通过指定 file_id 的方式在多模态内容中直接使用此文件。此接口上传的文件可用于发起对话等 API 中传入文件等多模态内容。使用方式可参考 object_string object

使用限制

限制

说明

文件大小

该 API 允许上传的最大文件大小为 512 MB。然而,在与智能体对话时,实际可使用的文件大小取决于智能体的模型版本。

上传方式

必须使用 multipart/form-data 方式上传文件。

有效期

  • 普通上传的文件将保存在扣子编程服务端,有效期为 3 个月。
  • 若上传的文件被用作扣子头像,则永久有效。

使用限制

  • 上传到扣子编程的文件仅限本账号查看或使用。
  • 调用此接口上传文件只能获得文件的 file_id,如需获取文件的 URL,建议将文件上传到专业的存储工具中。
  • 不支持下载已上传的文件。用户仅可在对话、工作流、端插件、RTC 和 WebSocket 中通过 file.id 访问和使用文件。

API 流控

  • 个人版:10 QPS。
  • 企业版:20 QPS。

支持的文件格式

文件类型

支持的格式

文档

DOC、DOCX、XLS、XLSX、PPT、PPTX、PDF、Numbers、CSV

文本文件

CPP、PY、JAVA、C

图片

JPG、JPG2、PNG、GIF、WEBP、HEIC、HEIF、BMP、PCD、TIFF

音频

WAV、MP3、FLAC、M4A、AAC、OGG、WMA、MIDI

视频

MP4、AVI、MOV、3GP、3GPP、FLV、WEBM、WMV、RMVB、M4V、MKV

压缩文件

RAR、ZIP、7Z、GZ、GZIP、BZ2

基础信息

请求方式

POST

请求地址

https://api.coze.cn/v1/files/upload

权限

uploadFile
确保调用该接口使用的访问令牌开通了 uploadFile 权限,详细信息参考鉴权方式

接口说明

调用接口上传文件到扣子编程。

请求参数

参数

取值

说明

Authorization

Bearer $Access_Token

用于验证客户端身份的访问令牌。你可以在扣子编程中生成访问令牌,详细信息,参考准备工作

Content-Type

multipart/form-data

解释请求正文的方式。

Body

参数

类型

是否必选

示例

说明

Data

File

必选

@“/test/1120.jpeg”’

待上传文件的二进制数据。
开发者需要在前端应用中实现文件选择功能,获取用户选择的文件后,将文件的二进制内容直接设置为 HTTP 请求体。

返回参数

参数

类型

示例

说明

data

Object of File

{ “bytes”: 152236, “created_at”: 1715847583, “file_name”: “1120.jpeg”, “id”: “736949598110202****” }

已上传的文件信息。

code

Long

0

调用状态码。0 表示调用成功,其他值表示调用失败,你可以通过 msg 字段判断详细的错误原因。

msg

String

“”

状态信息。API 调用失败时可通过此字段查看详细错误信息。
状态码为 0 时,msg 默认为空。

File

参数

类型

示例

说明

id

String

736949598110202****

已上传的文件 ID。

bytes

Long

152236

文件的总字节数。

file_name

String

1120.jpeg

文件名称。

created_at

Long

1715847583

文件的上传时间,格式为 10 位的 Unixtime 时间戳,单位为秒(s)。

示例

请求示例

curl --location --request POST 'https://api.coze.cn/v1/files/upload' \
--header 'Authorization : Bearer pat_O******' \
--header 'Content-Type: multipart/form-data' \
--form 'file=@"/test/1120.jpeg"'

返回示例

{
  "code": 0,
  "data": {
    "bytes": 152236,
    "created_at": 1715847583,
    "file_name": "1120.jpeg",
    "id": "736949598110202****"
  },
  "msg": ""
}

错误码

如果成功调用扣子编程的 API,返回信息中 code 字段为 0。如果状态码为其他值,则表示接口调用失败。此时 msg 字段中包含详细错误信息,你可以参考错误码文档查看对应的解决方法。