文档首页/ 应用平台 AppStage/ API参考/ API/ 应用中心/ 上传文件至文件盒子
更新时间:2025-03-12 GMT+08:00
分享

上传文件至文件盒子

功能介绍

在Agent的文件盒子中上传文件。在完成文件上传后,可以在调用Agent时引用上传的文件进行对话。只支持上传pdf、txt、docx等纯文本文件,且文件大小不超过10MB。

调用方法

请参见如何调用API

URI

POST https://aiae.appstage.myhuaweicloud.com/v1/routes/open/fileBox/upload

表1 Query参数

参数

是否必选

参数类型

描述

agent-id

String

参数解释:

Agent的唯一id。进入AI原生应用引擎,在左侧导航栏选择“Agent编排中心 > 我的Agent”,选择“我创建的”页签,选择列表操作列的“更多 > 修改”,在浏览器地址栏查看id。

约束限制:

不涉及。

取值范围:

由英文字母和数字组成,长度为32个字符。

默认取值:

不涉及。

attachment-code

String

参数解释:

附件码。此处请填写固定值:ai-file-box。

约束限制:

不涉及。

取值范围:

  • ai-file-box

默认取值:

不涉及。

file

String

参数解释:

待上传的文件。

约束限制:

文件需为pdf、txt、docx等文本文件,且大小不超过10MB。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Authorization

String

参数解释:

鉴权信息。获取平台API Key,并为API Key添加前缀Bearer,得到标准鉴权信息,例如Bearer sk-74e4157***。API Key获取方法请参见创建API Key

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

Content-Type

String

参数解释:

消息体的类型。

约束限制:

由于需要上传文件,所以必须为multipart/form-data。

取值范围:

  • application/json

  • application/json;charset=utf-8

  • multipart/form-data

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

data

String

参数解释:

生成的文件ID。

取值范围:

由英文字母和数字组成,长度为32个字符。

状态码:500

表4 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息。

取值范围:

不涉及。

请求示例

向Agent的文件盒子中上传上海旅游攻略文件。

/v1/routes/open/fileBox/upload

{
  "agent-id" : "1eb7f2f6f105496c8065be77dc038b63",
  "attachment-code" : "ai-file-box",
  "file" : "上海旅游攻略.docx"
}

响应示例

状态码:200

成功。

{
  "data" : "053f5dda365345a9a80cc63895df1647"
}

状态码:500

服务器内部错误或三方服务器内部错误。

{
  "error_code" : "AIAE.00001500",
  "error_msg" : "Internal Server Error."
}

状态码

状态码

描述

200

成功。

500

服务器内部错误或三方服务器内部错误。

错误码

请参见错误码

相关文档

    提示

    您即将访问非华为云网站,请注意账号财产安全