创建API服务
API管理模块可以对评测服务的API进行管理,在创建评测任务的时候选择评测服务即可。可以对API进行创建、编辑、删除。
- 登录ModelArts Studio平台,在“我的空间”模块,单击进入所需空间。
图1 我的空间
- 在左侧导航栏中选择“评测中心 > API管理”,单击界面右上角“创建API”。
- 定义API名称、模型系列,并选择模型类型和API描述(可选),单击“提交”。
图2 创建API

- API创建好以后,通过右侧新增版本来定义API的信息,可以新建多个版本。
- 单击“新增版本”,填写api参数,api各参数含义如表1
表1 API参数说明 参数名称
参数说明
版本类型
选择文生视频、图生视频或视频续写
版本
自定义
接口类型
同步接口:调用模型一次接口即可返回生成的视频
异步接口:先调用模型的创建任务接口,再调用模型的查询任务接口获取生成的视频
盘古的模型一般选择异步接口。
并发数
可以根据模型的性能进行配置,范围1~32。
QPM
可以根据模型的性能进行配置,范围1~5000。
URL(创建任务)
模型的创建任务接口地址
Param(创建任务)
模型的创建任务接口的参数和请求头
Body(创建任务)
模型的创建任务接口的body,“##message##”为提示词占位符,“##video##”为图片或视频占位符。示例:
{
"prompt": "##message##",
"origin_video": "##video##",
"video_config": {
"resolution": "720p",
"aspect_ratio": "16:9"
}
}
Response(创建任务)
任务id在响应json中的json路径,如$.id
URL(查询任务)
模型查询任务状态的接口地址,如果url包含任务id路径参数,可以用jobIdPlaceholder代替。
Param(查询任务)
模型查询任务状态的接口参数和请求头,如果请求参数值为任务id,可以用jobIdPlaceholder代替。
Status_path(查询任务)
模型查询任务状态的接口响应json中,状态字段的json路径,如$.status
Complete_status(查询任务)
模型查询任务状态的接口任务完成的状态值,多个值用#分隔,如PASS#FAIL
Result_path(查询任务)
模型查询任务状态的接口响应json中,生成的视频字段的json路径,如$.video_url
图3 新增版本
- 创建API版本后,需要验证API是否可用,只有验证通过的API才可以进行评测。在“API管理”页面单击创建好的API任务名称,单击“接口验证”输入问题后查看接口是否有响应内容输出。
图4 接口验证

验证API调用如果出现API调用失败,可能原因是:
- 接口配置错误,需要排查URL、请求参数等。