通过调用本接口，可以实现文件上传功能，上传后的文件可以用于创建知识库或作为多模态数据输入给应用。
说明：
- 支持多种文件类型（文本、图片、音频、视频等）。
- 具备鉴权、限流、内容安全等机制，以确保文件上传的安全性和稳定性。
- 文件有效期为 3 个月，过期将自动清理。
前提条件
在调用本接口前，请先完成应用的发布，若无，请参见：发布应用，完成相关事项。
请求地址
POSThttps://api.tbox.cn/api/file/upload
请求头
参数名称 |
是否必填 |
参数类型 |
描述 |
示例值 |
Authorization |
是 |
string |
用于验证客户端身份的访问令牌，你可以在百宝箱中获取，获取方式可参见：授权管理。 |
|
Content-Type |
是 |
string |
指定上传文件的格式 |
|
请求参数
参数名称 |
是否必填 |
参数类型 |
描述 |
示例值 |
file |
是 |
file |
需要上传的文件 |
本地文件路径 |
请求示例
curl -X POST 'https://api.tbox.cn/api/file/upload' -H "Authorization: ${token}" -H "Content-Type: multipart/form-data" --form 'file=@"${localFilePath}"'
返回参数
参数名称 |
参数类型 |
描述 |
示例值 |
data |
String |
文件上传成功后的文件 ID |
|
errorCode |
String |
状态码，非 0 表示失败 |
0 |
errorMsg |
String |
状态描述 |
success |
solution |
String |
问题解决方案，仅请求失败时返回 |
|
traceId |
String |
本次请求的唯一标识 |
0be8ed*********44067999e8721 |
返回示例
成功示例
{ "data": "123ddf32ddd", "errorCode": "0", "errorMsg": "success", "traceId": "0be8ed2317550023844067999e8721" }
失败示例
{ "errorCode": "P_1_13_813", "errorMsg": "令牌类型不匹配", "solution": "请使用正确类型的令牌", "traceId": "0be8ed2517550025084902701ec9f5" }
