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

上传文件用于调用Agent

功能介绍

该接口用于调用Agent前向AI原生应用引擎上传文件,目前仅支持图片格式(jpg、png、jpeg),为上传的文件提供访问路径,后续可以使用该访问路径调用Agent对话接口。

调用方法

请参见如何调用API

URI

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

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Authorization

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 请求Body参数

参数

是否必选

参数类型

描述

file

File

参数解释:

文件内容,目前仅支持jpg、png、jpeg格式的图片。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

type

String

参数解释:

文件类型,目前仅支持image图片类型。

约束限制:

不涉及。

取值范围:

image

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

url

String

参数解释:

文件路径,可用于调用Agent

取值范围:

不涉及。

状态码:500

表4 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息。

取值范围:

不涉及。

请求示例

{
  "file" : "binary string of image",
  "type" : "image"
}

响应示例

状态码:200

成功。

{
  "url" : "url of file"
}

状态码:500

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

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

状态码

状态码

描述

200

成功。

500

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

错误码

请参见错误码

相关文档

    OSZAR »