You need to enable JavaScript to run this app.
文档中心
即梦AI

即梦AI

复制全文
下载 pdf
小云雀-智能生视频Agent 2.0
小云雀-智能生视频Agent 2.0 无参考-接口文档
复制全文
下载 pdf
小云雀-智能生视频Agent 2.0 无参考-接口文档
接入说明​
请求说明​
​
名称​
内容​
接口地址​
请求方式​
POST​
Content-Type​
application/json​
​
提交任务​
提交任务请求参数​
Query参数​
​
参数​
类型​
可选/必选​
说明​
Action​
string​
必选​
接口名,取值:CVSync2AsyncSubmitTask​
Version​
string​
必选​
版本号,取值:2022-08-31​
​
Header参数​
注意​
本服务固定值:Region为cn-north-1,Service为cv​
主要用于鉴权,详见 公共参数 - 签名参数 - 在Header中的场景部分​
Body参数​
注意​
业务请求参数,放到request.body中,MIME-Type为application/json​
​
参数​
类型​
可选/必选​
说明​
req_key​
string​
必选​
服务标识​
取固定值: pippit_iv2v_v20_cvtob​
prompt​
string​
必选​
用于生成视频的提示词,中英文输入均可​
限制说明:​
  • 字数应 ≤ 2000,prompt过长有概率异常或指令不生效​
img_url_list​
array of string​
可选​
输入参考图URL(需公网可访问)​
限制说明:​
  • 个数要求:<= 50​
  • 图片要求:单张图片不超过20MB、分辨率不超过4096*4096​
ratio​
string​
可选​
画幅比例设置,默认Agent自动推荐​
可选取值:["16:9", "9:16", "4:3", "3:4"]​
duration​
string​
可选​
输出时长设置,默认Agent自动推荐​
可选取值:["~15s","~30s","40~60s", "1min+"]​
参考耗时:生成 60 秒视频,平均耗时约 10 分钟。​
特殊说明:视频输出时长由 Agent自主确定,模型会优先以传入的duration参数为目标时长进行匹配,最终生成的视频时长可能与目标值存在偏差。​
language​
string​
可选​
语言设置,中文效果最佳,可选取值:​
  • 中文(默认值):"Chinese"​
  • 英文:"English"​
  • 日语:"Japanese"​
  • 泰语:"Thai"​
  • 南非荷兰语:"SouthAfrican"​
  • 法语:"French"​
  • 土耳其语:"Turkish"​
  • 马来语:"Malay"​
  • 德语:"German"​
  • 韩语:"Korean"​
  • 俄语:"Russian"​
  • 西班牙语:"Spanish"​
  • 印尼语:"Indonesian"​
  • 意大利语:"Italian"​
  • 葡萄牙语:"Portuguese"​
  • 菲律宾语:"Filipino"​
  • 越南语:"Vietnamese"​
  • 荷兰语:"Dutch"​
  • 阿拉伯语:"Arabic"​
enable_watermark​
bool​
可选​
是否开启明水印,开启后视频左上角会显示“AI生成”、右下角会显示“小云雀AI生成”​
默认值:true​
​
提交任务返回参数​
通用返回参数​
业务返回参数​
重点关注data中以下字段,其他字段为公共返回(可忽略或不做解析)​
​
字段​
类型​
说明​
task_id​
string​
任务ID,用于查询结果​
​
提交任务请求&返回完整示例​
请求示例:​
​
{​
"req_key": "pippit_iv2v_v20_cvtob",​
"prompt": "输入提示词",​
"img_url_list": [​
"https://xxxx",​
// ...​
]​
}​
​
返回示例:​
​
{​
"code": 10000, //状态码,判断状态,code!=10000的情况下,不会返回task_id​
"data": {​
"task_id": "7392616336519610409" //任务ID,查询接口使用​
},​
"message": "Success",​
"request_id": "20240720103939AF0029465CF6A74E51EC", //排查错误的关键信息​
"time_elapsed": "104.852309ms" //链路耗时​
}​
​
查询任务​
查询任务请求参数​
Query参数​
​
参数​
类型​
可选/必选​
说明​
Action​
string​
必选​
接口名,固定值:CVSync2AsyncGetResult​
Version​
string​
必选​
版本号,固定值:2022-08-31​
​
Header参数​
注意​
本服务固定值:Region为cn-north-1,Service为cv​
主要用于鉴权,详见 公共参数 - 签名参数 - 在Header中的场景部分​
Body参数​
注意​
业务请求参数,放到request.body中,MIME-Type为application/json​
​
参数​
类型​
可选/必选​
说明​
​
req_key​
string​
必选​
服务标识​
取固定值: pippit_iv2v_v20_cvtob​
​
task_id​
string​
必选​
任务ID,此字段的取值为提交任务接口的返回​
​
req_json​
json string​
可选​
json序列化后的字符串,目前支持隐性水印配置,可在返回结果中添加​
示例:"{\"aigc_meta\": {\"content_producer\": \"xxxxxx\", \"producer_id\": \"xxxxxx\", \"content_propagator\": \"xxxxxx\", \"propagate_id\": \"xxxxxx\"}}"​
​
ReqJson(序列化后的结果再赋值给req_json)​
配置信息​
​
参数​
类型​
可选/必选​
说明​
​
aigc_meta​
AIGCMeta​
可选​
隐式标识​
隐式标识验证方式:​
​
AIGCMeta​
隐式标识,依据《人工智能生成合成内容标识办法》&《网络安全技术人工智能生成合成内容标识方法》​
​
名称​
类型​
可选/必选​
描述​
content_producer​
string​
可选​
内容生成服务ID(长度 <= 256字符)​
producer_id​
string​
必选​
内容生成服务商给此图片数据的唯一ID(长度 <= 256字符)​
content_propagator​
string​
必选​
内容传播服务商ID(长度 <= 256字符)​
propagate_id​
string​
可选​
传播服务商给此图片数据的唯一ID(长度 <= 256字符)​
​
查询任务返回参数​
通用返回参数​
业务返回参数​
说明​
重点关注data中以下字段,其他字段为公共返回(可忽略或不做解析)​
​
参数名​
类型​
​
video_url​
string​
生成的视频URL(有效期为 1 小时)​
resp_data​
JSON string​
附加数据,JSON字符串格式,可按需解析​
字段说明​
  • Duration:输出视频时长​
aigc_meta_tagged​
bool​
隐式标识是否打标成功​
status​
string​
任务执行状态​
  • processing:任务前置处理​
  • in_queue:任务已提交​
  • generating:任务已被消费,处理中​
  • done:处理完成,成功或者失败,可根据外层code&message进行判断​
  • not_found:任务未找到,可能原因是无此任务或任务已过期(12小时)​
  • expired:任务已过期,请尝试重新提交任务请求​
​
查询任务请求&返回完整示例​
请求示例:​
​
{​
"req_key": "pippit_iv2v_v20_cvtob",​
"task_id": "7491596536074305586",​
"req_json": "{\"aigc_meta\": {\"content_producer\": \"001191440300192203821610000\", \"producer_id\": \"producer_id_test123\", \"content_propagator\": \"001191440300192203821610000\", \"propagate_id\": \"propagate_id_test123\"}}"​
}​
​
返回示例:​
​
{​
"code": 10000, //状态码,优先判断 code=10000, 然后再判断data.status,否则解析有可能会panic​
"data": {​
"aigc_meta_tagged": true,​
"status": "done", //任务状态​
"video_url": "https://xxxx",​
"resp_data": "{\"Duration\":\"5.05\"}" // 附加数据,JSON字符串格式,可按需解析​
},​
"message": "Success",​
"status": 10000, //无需关注,请忽略​
"request_id": "2025061718460554C9B78D23B0BAB45B2A", //排查错误的关键信息​
"time_elapsed": "508.312154ms" //链路耗时​
}​
​
返回报错示例:​
​
{​
"code": 50413, //状态码,优先判断 code=10000, 然后再判断data.status,否则解析有可能会panic​
"data": null, //code!=10000的情况下,该字段返回为null​
"message": "Post Text Risk Not Pass", //错误信息​
"request_id": "202511281418218670D408837A9B0EB58F", //排查错误的关键信息​
"status": 50413, //无需关注,请忽略​
"time_elapsed": "36.799829ms" //链路耗时​
}​
​
错误码​
通用错误码​
业务错误码​
​
HttpCode​
错误码​
错误消息​
描述​
是否需要重试​
200​
10000​
无​
请求成功​
不需要​
400​
50411​
Pre Img Risk Not Pass​
输入图片前审核未通过​
不需要​
400​
50511​
Post Img Risk Not Pass​
输出图片后审核未通过​
可重试​
400​
50412​
Text Risk Not Pass​
输入文本前审核未通过​
不需要​
400​
50512​
Post Text Risk Not Pass​
输出文本后审核未通过​
不需要​
400​
50513​
Pre Video Risk Not Pass​
输入视频前审核未通过​
不需要​
400​
50514​
Pre Audio Risk Not Pass​
输入音频前审核未通过​
不需要​
400​
50413​
Post Text Risk Not Pass​
输入文本含敏感词、版权词等审核不通过​
不需要​
429​
50429​
Request Has Reached API Limit, Please Try Later​
QPS超限​
可重试​
429​
50430​
Request Has Reached API Concurrent Limit, Please Try Later​
并发超限​
可重试​
500​
50500​
Internal Error​
内部错误​
可重试​
500​
50501​
Internal RPC Error​
内部算法错误​
可重试​
​
接入说明​
SDK使用说明​
请参考SDK使用说明​
HTTP方式接入说明​
请参考HTTP请求示例​
​
最近更新时间:2026.06.30 11:17:19
这个页面对您有帮助吗?
有用
有用
无用
无用