文档中心

智能视觉服务

视频生成-视频特效

接口文档（公测）

限制条件

名称	内容
图片要求	图片格式：JPG(JPEG), PNG等常见格式, 建议使用JPG格式图片要求：强烈建议：文件小于5 MB，分辨率大于10001000，小于40964096；推荐宽高比例范围：9:16~16:9（极端比例效果欠佳，有概率报错）

请求说明

名称	内容
接口地址	https://visual.volcengineapi.com
请求方式	POST
Content-Type	application/json

提交任务

提交任务请求参数

Query参数

拼接到url后的参数，示例：https://visual.volcengineapi.com?Action=CVSync2AsyncSubmitTask&Version=2022-08-31

参数	可选/必选	类型	说明
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	是	服务标识取固定值: i2v_bytedance_effects_v1
image_input	string	是	输入图URL链接注意：当template_id为double_embrace（爱的拥抱双图）时，需要传入两张图片的链接，两个链接使用"\|"连接例："https://person1.jpg\|https://person2.png" 除double_embrace（爱的拥抱双图）外其他template_id仅需传入一张图片的链接
template_id	string	是	风格模板ID，可选取值： "becoming_doll"：变身玩偶_480p版 "becoming_doll_720p"：变身玩偶_720p版 "all_things_ridability_pig"：召唤坐骑 - 猪_480p版 "all_things_ridability_pig_720p"：召唤坐骑 - 猪_720p版 "all_things_ridability_tiger"：召唤坐骑 - 老虎_480p版 "all_things_ridability_tiger_720p"：召唤坐骑 - 老虎_720p版 "all_things_ridability_loong"：召唤坐骑 - 龙_480p版 "all_things_ridability_loong_720p"：召唤坐骑 - 龙_720p版 "all_things_bloom_with_flowers"：万物生花_480p版 "all_things_bloom_with_flowers_720p"：万物生花_720p版 "double_embrace_single_person": 爱的拥抱（单图）_480p版 "double_embrace_single_person_720p": 爱的拥抱（单图）_720p版 "double_embrace"：爱的拥抱（双图）_480p版 "double_embrace_720p"：爱的拥抱（双图）_720p版 "beauty_surround"：AI美女环绕_480p版 "beauty_surround_720p"：AI美女环绕__720p版 "handsome_man_surround"：AI帅哥环绕_480p版 "handsome_man_surround_720p"：AI帅哥环绕_720p版 "ai_baby"：天赐宝宝_480p版 "ai_baby_720p"：天赐宝宝_720p版

提交任务返回参数

通用返回参数

请参考通用返回字段及错误码

业务返回参数

重点关注data中以下字段，其他字段为公共返回(可忽略或不做解析)

字段	类型	说明
task_id	string	任务ID，用于查询结果

提交任务请求&返回完整示例

请求示例：

返回示例：

查询任务

查询任务请求参数

Query参数

拼接到url后的参数，示例：https://visual.volcengineapi.com?Action=CVSync2AsyncGetResult&Version=2022-08-31

参数	可选/必选	类型	说明
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	服务标识取固定值: i2v_bytedance_effects_v1
task_id	必选	String	任务ID，此字段的取值为提交任务接口的返回

查询任务返回参数

通用返回参数

请参考通用返回字段及错误码

业务返回参数

说明

重点关注以下字段，其他字段为公共返回(可忽略或不做解析)

参数名	参数说明	参数示例
video_url	视频链接（有效期为 1 小时）
status	任务执行状态 in_queue：任务已提交 generating：任务已被消费，处理中 done：处理完成，成功或者失败，可根据外层code&message进行判断 not_found：任务未找到，可能原因是无此任务或任务已过期(12小时) expired：任务已过期，请尝试重新提交任务请求

查询任务请求&返回完整示例

请求示例：

返回示例：

错误码

通用错误码

请参考通用返回字段及错误码

业务错误码

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	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请求示例

最近更新时间：2025.08.12 01:04:11

这个页面对您有帮助吗？

有用

无用