文件上传
POST
/api/v1/user/files/upload简介
上传一个文件到文件存储服务中,目前此接口仅支持约100MB以下的文件上传,有计划支持大文件上传,大文件分段上传接口会在后续开发。
参数描述
字段名 | 类型 | 必需 | 示例值 | 备注 |
---|---|---|---|---|
file | file | true | 文件 | 文件数据 |
filename | string | true | GdIDB9HakAAiVFK.jpg | 文件名 |
purpose | string | true | 0 | 文件用途 |
is_public | string | false | true | 是否公开(可选) 默认私有 |
tags | string | false | ["t1"] | 文件标签标记(可选) 可用于筛选文件 |
expires_at | string | false | 2024-11-29T22:14:53+08:00 | 文件过期时间(可选) 若到期系统会自动删除 用于存储临时文件时推荐设置此属性 |
调用此接口需要提供有效的APIKey凭证,如果启用了APIKey权限检查,需要具备 file-v1
的权限
附:
文件用途purpose
定义:
{
COMMON = 0,
FINETUNE = 1,
CHAT = 2,
LLM_TMP = 3,
OPENAI_BATCH = 4,
ANTHROPIC_BATCH = 5,
}
请求参数
Body 参数multipart/form-data
file
file
文件数据
示例值:
file://C:\Users\hash070\Downloads\GdIDB9HakAAiVFK.jpg
filename
string
文件名
示例值:
GdIDB9HakAAiVFK.jpg
purpose
string
文件用途
示例值:
0
is_public
string
可选
是否公开(可选) 默认私有
示例值:
true
tags
array[string]
可选
文件标签标记(可选) 可用于筛选文件
示例值:
["t1","t2"]
expires_at
string
可选
文件过期时间(可选) 若到期系统会自动删除 用于存储临时文件时推荐设置此属性
示例值:
2024-11-29T22:14:53+08:00
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
object {0}
示例
{
"statusCode": 200,
"message": "File Upload Success",
"data": {
"fileUniqueID": "ENthMCy_5zr5zN3GRJseM"
}
}
最后修改时间: 7 天前