开发工具/API 参考/文件/上传文件
上传文件
更新于: 2026-06-25 19:29:14
调用接口上传文件到扣子编程。
消息中无法直接使用本地文件,创建消息或对话前,需要先调用此接口上传本地文件到扣子编程。上传文件后,你可以在消息中通过指定 file_id 的方式在多模态内容中直接使用此文件。此接口上传的文件可用于发起对话等 API 中传入文件等多模态内容。使用方式可参考 object_string object 。
|
限制 |
说明 |
|---|---|
|
文件大小 |
该 API 允许上传的最大文件大小为 512 MB。然而,在与智能体对话时,实际可使用的文件大小取决于智能体的模型版本。 |
|
上传方式 |
必须使用 multipart/form-data 方式上传文件。 |
|
有效期 |
|
|
使用限制 |
|
|
API 流控 |
|
|
文件类型 |
支持的格式 |
|---|---|
|
文档 |
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 |
|---|---|
|
请求地址 |
|
|
权限 |
|
|
接口说明 |
调用接口上传文件到扣子编程。 |
|
参数 |
取值 |
说明 |
|---|---|---|
|
Authorization |
Bearer $Access_Token |
用于验证客户端身份的访问令牌。你可以在扣子编程中生成访问令牌,详细信息,参考准备工作。 |
|
Content-Type |
multipart/form-data |
解释请求正文的方式。 |
|
参数 |
类型 |
是否必选 |
示例 |
说明 |
|---|---|---|---|---|
|
Data |
File |
必选 |
@“/test/1120.jpeg”’ |
待上传文件的二进制数据。 |
|
参数 |
类型 |
示例 |
说明 |
|---|---|---|---|
|
data |
Object of File |
{ “bytes”: 152236, “created_at”: 1715847583, “file_name”: “1120.jpeg”, “id”: “736949598110202****” } |
已上传的文件信息。 |
|
code |
Long |
0 |
调用状态码。0 表示调用成功,其他值表示调用失败,你可以通过 msg 字段判断详细的错误原因。 |
|
msg |
String |
“” |
状态信息。API 调用失败时可通过此字段查看详细错误信息。 |
|
参数 |
类型 |
示例 |
说明 |
|---|---|---|---|
|
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 字段中包含详细错误信息,你可以参考错误码文档查看对应的解决方法。