提交任务(生成视频模板)
1.1 简要描述
生成视频模板
1.2 请求URL
/openapi/queue/effects/submit/zaoTools?app_id=xxx&access_token=xxx
1.3 请求方式
POST
1.4 入参
参数名 |
参数类型 |
默认值 |
是否必传 |
描述 |
openId |
string |
|
是 |
openId |
input |
list |
|
是 |
输入素材,图片/视频等 |
input[].name |
string |
|
否 |
素材名称 |
input[].dataUrl |
string |
|
否 |
dataUrl和dataBytes二选一 |
input[].dataBytes |
string |
|
否 |
Base64字符串,如何从图片的二进制获得base64字符串:org.apache.commons.codec.binary.Base64.encodeBase64String(bytes.toByteArray()) |
effect |
string |
|
是 |
能力名称,具体支持列表参见 |
argument |
map |
|
否 |
额外参数,参见具体方法说明 |
1.5 出参
参数名 |
参数类型 |
默认值 |
描述 |
result |
int |
|
错误码,0为成功,其它失败,参见返回错误码说明 |
errorMsg |
string |
|
错误信息 |
requestId |
string |
|
请求id,可用于查询任务 |
taskInfo |
object |
|
|
taskStatus |
string |
|
排队中、运行中、已完成、已取消、已失败 |
etaTime |
long |
|
预计完成时间戳 |
queueSize |
int |
|
队列位置 |
beginTime |
long |
|
开始时间戳 |
endTime |
long |
|
完成时间戳 |
taskPercent |
string |
|
进度百分比0-100 |
data |
object |
|
|
data.image |
string |
|
图片Base64字符串,例如"data:image/png;base64,/9j/4AA" |
data.type |
string |
|
image:图片 |
data.video |
string |
|
视频Base64字符串 |
1.6 错误码
错误码 |
错误信息 |
描述 |
SUCCESS0 |
|
成功 |
UNRECOGNIZED-1 |
|
未识别 |
NO_RESULTS1 |
|
没有结果 |
NO_FACE2 |
|
没有人脸 |
NO_HUMAN3 |
|
没有人 |
SIZE_MISMATCH4 |
|
输入图片大小/通道不匹配 |
RUN_ERROR5 |
|
运行错误 |
PARAM_ERROR6 |
|
无效输入参数 |
NO_BANDWIDTH12 |
|
无带宽 |
OUT_OF_QUOTA20 |
|
特效被限流 |
ERR_CV201 |
|
cv异常(输入图片错误) |
ERR_STD202 |
|
std异常 |
ERR_OTHER203 |
|
其他错误 |
1.7 示例
{
"result": 0,
"errorMsg": "",
"requestId":"请求id", // 查询任务所需字段
"effect":"",
"taskInfo":{
"taskStatus":"", //排队中、运行中、已完成、已取消、已失败
"etaTime":"", // 预计完成时间
"queueSize":0, // 队列位置
"beginTime":"时间戳",
"endTime":"实际完成时间",
"taskPercent":"1" // 进度百分比0-100
},
"data": {
"image":"data:image/png;base64,/9j/4AA",
"video":"",
"type":"image" // video / image
查询任务(查询视频模板ID)
2.1 简要描述
查询任务(查询视频模板ID)
2.2 请求URL
/openapi/queue/effects/query?app_id=xxx&access_token=xxx
2.3 请求方式
POST
2.4 入参
参数名 |
参数类型 |
默认值 |
是否必传 |
描述 |
openId |
string |
|
否 |
openId |
requestId |
string |
|
否 |
提交任务返回的requestId |
2.5 出参
参数名 |
参数类型 |
默认值 |
描述 |
result |
int |
|
错误码,0为成功,其它失败,参见返回错误码说明 |
errorMsg |
string |
|
错误信息 |
requestId |
string |
|
请求id,可用于查询任务 |
taskInfo |
object |
|
|
taskStatus |
string |
|
排队中、运行中、已完成、已取消、已失败 |
etaTime |
long |
|
预计完成时间戳 |
queueSize |
int |
|
队列位置 |
beginTime |
long |
|
开始时间戳 |
endTime |
long |
|
完成时间戳 |
taskPercent |
string |
|
进度百分比0-100 |
data |
object |
|
|
data.image |
string |
|
图片Base64字符串,例如"data:image/png;base64,/9j/4AA" |
data.type |
string |
|
image:图片 |
data.video |
string |
|
视频Base64字符串 |
2.6 错误码
2.7 示例
提交任务
3.1 简要描述
提交任务
3.2 请求URL
/openapi/queue/effects/submit/zaoVideo?app_id=xxx&access_token=xxx
3.3 请求方式
POST
3.4 入参
参数名 |
参数类型 |
默认值 |
是否必传 |
描述 |
openId |
string |
|
是 |
openId |
input |
list |
|
是 |
输入素材,图片/视频等 |
input[].name |
string |
|
否 |
素材名称 |
input[].dataUrl |
string |
|
否 |
dataUrl和dataBytes二选一 |
input[].dataBytes |
string |
|
否 |
Base64字符串,如何从图片的二进制获得base64字符串:org.apache.commons.codec.binary.Base64.encodeBase64String(bytes.toByteArray()) |
effect |
string |
|
是 |
能力名称,具体支持列表参见 |
argument |
map |
|
否 |
额外参数,参见具体方法说明 |
3.5 出参
参数名 |
参数类型 |
默认值 |
描述 |
result |
int |
|
错误码,0为成功,其它失败,参见返回错误码说明 |
errorMsg |
string |
|
错误信息 |
requestId |
string |
|
请求id,可用于查询任务 |
taskInfo |
object |
|
|
taskStatus |
string |
|
排队中、运行中、已完成、已取消、已失败 |
etaTime |
long |
|
预计完成时间戳 |
queueSize |
int |
|
队列位置 |
beginTime |
long |
|
开始时间戳 |
endTime |
long |
|
完成时间戳 |
taskPercent |
string |
|
进度百分比0-100 |
data |
object |
|
|
data.image |
string |
|
图片Base64字符串,例如"data:image/png;base64,/9j/4AA" |
data.type |
string |
|
image:图片 |
data.video |
string |
|
视频Base64字符串 |
3.6 错误码
3.7 示例
查询任务
4.1 简要描述
查询任务
4.2 请求URL
/openapi/queue/effects/query?app_id=xxx&access_token=xxx
4.3 请求方式
POST
4.4 入参
参数名 |
参数类型 |
默认值 |
是否必传 |
描述 |
openId |
string |
|
是 |
openId |
requestId |
string |
|
是 |
提交任务返回的requestId |
4.5 出参
参数名 |
参数类型 |
默认值 |
描述 |
result |
int |
|
错误码,0为成功,其它失败,参见返回错误码说明 |
errorMsg |
string |
|
错误信息 |
requestId |
string |
|
请求id,可用于查询任务 |
taskInfo |
object |
|
|
taskStatus |
string |
|
排队中、运行中、已完成、已取消、已失败 |
etaTime |
long |
|
预计完成时间戳 |
queueSize |
int |
|
队列位置 |
beginTime |
long |
|
开始时间戳 |
endTime |
long |
|
完成时间戳 |
taskPercent |
string |
|
进度百分比0-100 |
data |
object |
|
|
data.image |
string |
|
图片Base64字符串,例如"data:image/png;base64,/9j/4AA" |
data.type |
string |
|
image:图片 |
data.video |
string |
|
视频Base64字符串 |
4.6 错误码
4.7 示例
取消任务
5.1 简要描述
取消任务
5.2 请求URL
/openapi/queue/effects/cancel?app_id=xxx&access_token=xxx
5.3 请求方式
POST
5.4 入参
参数名 |
参数类型 |
默认值 |
是否必传 |
描述 |
openId |
string |
|
是 |
openId |
requestId |
string |
|
是 |
提交任务返回的requestId |
5.5 出参
参数名 |
参数类型 |
默认值 |
描述 |
result |
int |
|
错误码,0为成功,其它失败,参见返回错误码说明 |
errorMsg |
string |
|
错误信息 |
requestId |
string |
|
请求id,可用于查询任务 |
taskInfo |
object |
|
|
taskStatus |
string |
|
排队中、运行中、已完成、已取消、已失败 |
etaTime |
long |
|
预计完成时间戳 |
queueSize |
int |
|
队列位置 |
beginTime |
long |
|
开始时间戳 |
endTime |
long |
|
完成时间戳 |
taskPercent |
string |
|
进度百分比0-100 |
data |
object |
|
|
data.image |
string |
|
图片Base64字符串,例如"data:image/png;base64,/9j/4AA" |
data.type |
string |
|
image:图片 |
data.video |
string |
|
视频Base64字符串 |
5.6 错误码
5.7 示例
查询任务列表
6.1 简要描述
查询任务列表
6.2 请求URL
/openapi/queue/effects/list?app_id=xxx&access_token=xxx
6.3 请求方式
POST
6.4 入参
参数名 |
参数类型 |
默认值 |
是否必传 |
描述 |
openId |
string |
|
是 |
openId |
pageNum |
int |
|
否 |
页码,从1开始 |
pageSize |
int |
|
否 |
一页数量,最大值:100 |
effect |
string |
|
否 |
特效名称 |
task_status |
string |
|
否 |
排队中、已完成、已取消、已失败请求 |
6.5 出参
参数名 |
参数类型 |
默认值 |
描述 |
result |
int |
|
错误码,0为成功,其它失败,参见返回错误码说明 |
errorMsg |
string |
|
错误信息 |
totalSize |
int |
|
总数量 |
dataList |
list |
|
|
requestId |
string |
|
请求id,可用于查询任务 |
taskInfo |
object |
|
任务排队等信息 |
taskStatus |
string |
|
排队中、运行中、已完成、已取消、已失败 |
etaTime |
long |
|
预计完成时间戳 |
queueSize |
int |
|
队列位置 |
beginTime |
long |
|
开始时间戳 |
endTime |
long |
|
完成时间戳 |
taskPercent |
string |
|
进度百分比0-100 |
6.6 错误码
错误码 |
错误信息 |
描述 |
SUCCESS0 |
|
成功 |
UNRECOGNIZED-1 |
|
未识别 |
NO_RESULTS1 |
|
没有结果 |
NO_FACE2 |
|
没有人脸 |
NO_HUMAN3 |
|
没有人 |
SIZE_MISMATCH4 |
|
输入图片大小/通道不匹配 |
RUN_ERROR5 |
|
运行错误 |
PARAM_ERROR6 |
|
无效输入参数 |
NO_BANDWIDTH12 |
|
无带宽 |
OUT_OF_QUOTA20 |
|
特效被限流 |
ERR_CV201 |
|
cv异常(输入图片错误) |
ERR_STD202 |
|
std异常 |
ERR_OTHER203 |
|
其他错误 |
6.7 示例
{
"result": 0,
"errorMsg": "",
"dataList":[
{
"requestId":"请求id",
"effect":"",
"taskInfo":{
"taskStatus":"",
"etaTime":"", // 预计完成时间
"queueSize":0, // 队列位置
"beginTime":"时间戳",
"endTime":"实际完成时间",
"taskPercent":"1" // 进度百分比0-100
}
}
]
}