文件上传

line1

https://cn2us02.opapi.win

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,
}

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Body 参数multipart/form-data

返回响应

🟢200成功

application/json

Body

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://cn2us02.opapi.win/api/v1/user/files/upload' \
--header 'Authorization: Bearer <token>' \
--form 'file=@"C:\\Users\\hash070\\Downloads\\GdIDB9HakAAiVFK.jpg"' \
--form 'filename="GdIDB9HakAAiVFK.jpg"' \
--form 'purpose="0"' \
--form 'is_public="true"' \
--form 'tags="t1"' \
--form 'tags="t2"' \
--form 'expires_at="2024-11-29T22:14:53+08:00"'

响应示例

{
    "statusCode": 200,
    "message": "File Upload Success",
    "data": {
        "fileUniqueID": "ENthMCy_5zr5zN3GRJseM"
    }
}

修改于 2024-11-27 15:50:04

文件存储服务

文件信息更新

文件上传

简介#

参数描述#

请求参数

返回响应

简介

参数描述