跳转到主要内容
POST
Upload A File

授权

x-auth-token
string
header
必填

用于请求 API 的 Token。

请求头

x-on-behalf-of
string

设置为关联账户 ID 的值。更多信息参见 列出关联账户

x-idempotency-key
string<uuid>
必填

用于保持操作幂等性的唯一标识符(UUID),确保同一操作的重复执行不会产生意外影响或重复结果。在出现网络错误、重试或失败时,它有助于保持数据一致性。

查询参数

notes
string

所上传文件的备注,最大长度为 50 个字符。

Maximum string length: 50

请求体

multipart/form-data
file
file

响应

200 - application/json

OK——文件上传成功。

create_time
string
必填

文件上传的时间戳。

示例:

"2024-08-22T17:12:58+08:00"

file_id
string
必填

所上传文件的唯一标识符。在其他 API 调用中使用该 ID 来引用此文件。

示例:

"b3d9d2d5-4c12-4946-a09d-953e82sed2b0"

file_name
string
必填

所上传文件的原始名称(含扩展名)。

示例:

"example.png"

file_type
string
必填

文件扩展名类型(例如 pngpdfdocx)。

示例:

"png"

size
integer
必填

文件大小,单位为字节。

示例:

123456

notes
string
必填

与该文件关联的可选备注。

示例:

"This is a note"