文档中心

调用方式（按量计费）

最近更新时间：2024.01.24 17:36:39

首次发布时间：2023.04.04 16:01:37

测试与费用说明

公测版相较历史版本增加了眼镜适配功能，因大角度造成的抖动问题得到缓解，融合美感及清晰度均有提升，性能略有损耗，若有需要可升级到公测版本

如需接入测试，请联系火山商务经理为您开通测试权限。本服务为免费试用客户提供2.5小时免费试用额度（以视频输入时长计），额度用尽后，继续使用此服务需转为正式调用状态。

若您在服务中针对图片有强人像美化需求，可联系火山技术顾问做相应调整。

说明

该服务为异步调用，分为任务提交和任务查询两步骤

异步调用方式-任务提交

接口简介

基于3D人脸/GAN等计算机视觉技术，将用户脸部自然融入素材之中，构建完善的视频人脸融合解决方案，输入待处理的视频以及需要换脸的图片，返回人脸融合之后的视频。

限制条件

名称	内容
图片要求	1.图片格式：建议使用jpg/jpeg、png格式，其余格式可能会报错，后续逐步开放。 2.图片大小：Base64不超过5MB, url不超过10M 3.图片分辨率：最小128128，最大4096 4096
视频要求	1.视频格式：MP4、MOV格式，建议使用MP4格式，其余格式会被拒绝，其余格式能力后续开放。（不支持高动态范围（HDR）视频编码） 2.视频时长：时长不大于60s，帧率不大于30fps，分辨率不超过1080P 3.视频大小：不超过500MB

请求说明

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

请求参数

（1）header请求参数

公共请求参数

以下请求参数列表仅列出了接口请求参数和必要公共参数，完整公共参数列表见公共参数

名称	类型	是否必填	描述
X-Date	String	是	使用UTC时间，精确到秒。请使用格式：`YYYYMMDD'T'HHMMSS'Z'` ，例如：`20201103T104027Z`
Authorization	String	是	HMAC-SHA256：签名方法 -Credential为签名凭证，其中: -AccessKeyId为访问密钥ID，可在访问密钥（Access Key）获取； -ShortDate为请求的短时间，使用UTC时间，精确到日。请使用格式：`YYYYMMDD`，例如：`20180201`； -Region为请求地区，国内一般为为`cn-north-1`； -Service为请求的服务，一般为`cv`； -SignedHeaders为参与签名计算的头部信息，`content-type` 和 `host` 为必选头部； -Signature为签名，可在签名方法获取。注：我们提供了SDK及签名示例供您实现服务快速接入，具体可参考快速接入例如：`HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}`
X-Security-Token	String	否	指安全令牌服务（Security Token Service，STS）颁发的临时安全凭证中的SessionToken，使用长期密钥时无需填写该参数。

（2）Query参数

业务请求参数

参数	可选/必选	类型	说明
Action	必选	String	接口名，取值：FaceFusionMovieSubmitTask
Version	必选	String	版本号，取值：2022-08-31

（3）Body参数

业务请求参数

参数	可选/必选	类型	说明	备注
req_key	必选	String	算法名称，取固定值为facefusionmovie_usage
image_url	必选	String	输入换脸的图片链接，支持2个人脸图链接，多个链接之间使用逗号分隔	支持多个人脸图下载链接
video_url	必选	String	输入待处理的视频链接
ref_img_url	可选	String	指定视频中待融合人脸的图像URL地址。当视频中有多个人脸时，通过该参数提供的人脸清晰正面照，可以指定要融合人脸的人物，该参数填写待融合人脸的图像URL地址。当视频中仅有一人，或需要融合不特定某人的人脸时，该参数可填写空字符串。多个人脸时用逗号分隔，顺序与image_url一致。	顺序需一致
source_similarity	可选	String	人脸相似度: 范围[0~1]，越大越相似. 0: 不换脸 1: 最大相似度。默认1（同原来效果）
logo_info	可选	LogoInfo	水印信息

LogoInfo
水印相关信息。

名称	类型	必选	描述
add_logo	Boolean	否	是否添加水印。True为添加，False不添加。默认不添加
position	Int	否	水印的位置，取值如下： 0-右下角 1-左下角 2-左上角 3-右上角默认0
language	Int	否	水印的语言，取值如下： 0-中文（AI生成） 1-英文（Generated by AI）默认0
opacity	Float	否	水印的不透明度，取值范围0-1，1表示完全不透明，默认0.3

输出说明

（1）通用输出参数

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

（2）业务输出参数

data字段

字段	类型	说明
task_id	String	任务id，用于后续结果查询。

（3）输出示例

{
    "code":10000,
    "data":{
        "task_id":"7148337835908137003"
    },
    "message":"Success",
    "request_id":"20220928160139010210058164043A3882",
    "status":10000,
    "time_elapsed":"36.407136ms"
}

错误码

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

（2）业务错误码

http code	错误码	错误信息	说明
200	10000	Success	成功

异步调用方式-任务查询

接口简介

视频人脸融合的任务查询。

请求说明

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

请求参数

（1）header请求参数
公共请求参数

名称	类型	是否必填	示例值	描述
X-Date	String	是	20201103T104027Z	使用UTC标准时间，日期精确到秒，格式：YYYYMMDD'T'HHMMSS'Z'。
Authorization	String	是	HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}	HMAC-SHA256：签名方法 Credential：签名凭证，其中， -AccessKeyId是访问密钥ID，可在访问密钥（Access Key）获取； -ShortDate是请求的短时间，使用UTC时间，精确到日。请使用格式：YYYYMMDD，例如：20180201 -Region默认为cn-north-1 -Service默认为cv SignedHeaders是参与签名计算的头部信息，content-type 和 host 为必选头部 Signature是签名，可在签名方法获取。注：我们提供了SDK及签名示例供您实现服务快速接入，具体可参考快速接入
X-Security-Token	String	否	无	指安全令牌服务（Security Token Service，STS）颁发的临时安全凭证中的SessionToken： 1.用户 / Service 访问自己的资源则可以使用 AK/SK 直接访问（长期 Token），无需填写该参数。 2.用户 / Service 通过扮演角色去调用接口时需要使用 STS。具体流程：先调用 AssumeRole 获得短期 token, 然后将该 Token 放入该参数去请求目标接口。
Content-Type	String	是	application/json	编码格式

（2）Query参数

参数	可选/必选	类型	说明
Action	必选	String	接口名，取值：FaceFusionMovieGetResult
Version	必选	String	版本号，取值：2022-08-31

（3）Body参数

参数	可选/必选	类型	说明
req_key	必选	String	算法名称，取固定值：facefusionmovie_usage
task_id	必选	String	任务ID

输出说明

（1）通用输出参数

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

（2）业务输出参数

data字段

字段	类型	说明
status	String	任务状态。 `not_found`：任务无法查询到，此种情况一般为任务已过期 `in_queue`：已提交队列 `generating`：已开始生成 `done`：已完成，注意任务完成并非处理成功，需进一步检查错误码和错误信息
binary_data_base64	array of String	返回资源文件 base64 列表
resp_data	String	序列化后的返回数据，包括video_url，人脸融合之后的视频链接，链接有效期1h

（3）输出示例

{
    "code":10000,
    "data":{
        "binary_data_base64":[

        ],
        "resp_data":"{\"progress\": 100, \"received_at\": 1664525600, \"finished_at\": 1664525782, \"vid\": \"v0383eg10001ccrablbc77u5n7asig2g\", \"video_url\": \"https://v3-vvecloud.yangyi08.com/33bc2cc1aaa1f424d48c8a1436242c32/6336b3f1/video/tos/cn/tos-cn-v-07ec30/224dc306b7e44290a03af44d32779ea7/?a=7073\u0026ch=0\u0026cr=0\u0026dr=4\u0026er=0\u0026lr=unwatermarked\u0026cd=0%7C0%7C0%7C0\u0026br=2720\u0026bt=2720\u0026cs=0\u0026ds=3\u0026ft=Q3AOVNnnrThWH6l1ba-bmo\u0026mime_type=video_mp4\u0026qs=13\u0026rc=amp2Ojg6Zm9kZjQzNGg7M0Bpamp2Ojg6Zm9kZjQzNGg7M0AvZl5rcjRfX29gLS1kMDBzYSMvZl5rcjRfX29gLS1kMDBzcw%3D%3D\u0026l=202209301613190102120910910545813E\"}",
        "status":"done"
    },
    "message":"Success",
    "request_id":"2022093016171801021216015400461491",
    "status":10000,
    "time_elapsed":"140.539139ms"
}

错误码

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

（2）业务错误码

http code	错误码	错误信息	说明
200	10000	Success	成功

~~***

【已废弃】同步调用方式

同步调用方式已废弃，请参考上文使用异步方式进行调用。

请求说明

同步接口建议的视频长度<10s，分辨率<720p，大小<10MB，同步接口超时上限为30s，可能会有一定超时风险，规避超时风险建议接入异步接口。

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

请求参数

（1）header请求参数

公共请求参数

以下请求参数列表仅列出了接口请求参数和必要公共参数，完整公共参数列表见公共参数

名称	类型	是否必填	描述
X-Date	String	是	使用UTC时间，精确到秒。请使用格式：`YYYYMMDD'T'HHMMSS'Z'` ，例如：`20201103T104027Z`
Authorization	String	是	HMAC-SHA256：签名方法 -Credential为签名凭证，其中: -AccessKeyId为访问密钥ID，可在访问密钥（Access Key）获取； -ShortDate为请求的短时间，使用UTC时间，精确到日。请使用格式：`YYYYMMDD`，例如：`20180201`； -Region为请求地区，国内一般为为`cn-north-1`； -Service为请求的服务，一般为`cv`； -SignedHeaders为参与签名计算的头部信息，`content-type` 和 `host` 为必选头部； -Signature为签名，可在签名方法获取。注：我们提供了SDK及签名示例供您实现服务快速接入，具体可参考快速接入例如：`HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}`
X-Security-Token	String	否	指安全令牌服务（Security Token Service，STS）颁发的临时安全凭证中的SessionToken，使用长期密钥时无需填写该参数。

（2）Query参数

业务请求参数

参数	可选/必选	类型	说明
Action	必选	String	接口名，取值：FaceFusionMovie
Version	必选	String	版本号，取值：2022-08-31

（3）Body参数

业务请求参数

参数	可选/必选	类型	说明	备注
req_key	必选	String	算法名称，取固定值为facefusionmovie_usage
binary_data_base64	必选（与image_url二选一，优先级高于image_url）	Array of String	输入换脸的图片Base64数组，支持2张人脸图	支持多张人脸图
image_url	必选（与binary_data_base64二选一，优先级低于binary_data_base64）	String	输入换脸的图片链接，支持2个人脸图链接，多个链接之间使用逗号分隔	支持多个人脸图下载链接
video_url	必选	String	输入待处理的视频链接
ref_img_url	可选	String	指定视频中待融合人脸的图像URL地址。当视频中有多个人脸时，通过该参数提供的人脸清晰正面照，可以指定要融合人脸的人物，该参数填写待融合人脸的图像URL地址。当视频中仅有一人，或需要融合不特定某人的人脸时，该参数可填写空字符串。多个人脸时用逗号分隔，顺序与image_url或binary_data_base64一致。	顺序需一致
source_similarity	可选	String	人脸相似度: 范围[0~1]，越大越相似. 0: 不换脸 1: 最大相似度。默认1（同原来效果）
logo_info	可选	LogoInfo	水印信息

LogoInfo
水印相关信息。

名称	类型	必选	描述
add_logo	Boolean	否	是否添加水印。True为添加，False不添加。默认不添加
position	Int	否	水印的位置，取值如下： 0-右下角 1-左下角 2-左上角 3-右上角默认0
language	Int	否	水印的语言，取值如下： 0-中文（AI生成） 1-英文（Generated by AI）默认0
opacity	Float	否	水印的不透明度，取值范围0-1，1表示完全不透明，默认0.3

（4）请求示例

{
    "req_key": "facefusionmovie_standard",
    // "binary_data_base64": ["/9xxx", "/9xxx"],
    "image_url": "https:xxx, https:xxx",
    "video_url": "https://xxx",
    "ref_img_url": "https:xxx, https:xxx",
    "enable_face_beautify": true,
    "logo_info":{
    	"add_logo": true,
    	"position": 1,
    	"language": 1
    }
}

输出说明

（1）通用输出参数

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

（2）业务输出参数

data字段

字段	类型	说明
video_url	String	生成视频url

（3）输出示例

{
    "code":10000,
    "data":{
        "video_url":"https://v3-vvecloud.yangyi08.com/33bc2cc1aaa1f424d48c8a1436242c32/6336b3f1/video/tos/cn/tos-cn-v-07ec30/224dc306b7e44290a03af44d32779ea7/?a=7073\u0026ch=0\u0026cr=0\u0026dr=4\u0026er=0\u0026lr=unwatermarked\u0026cd=0%7C0%7C0%7C0\u0026br=2720\u0026bt=2720\u0026cs=0\u0026ds=3\u0026ft=Q3AOVNnnrThWH6l1ba-bmo\u0026mime_type=video_mp4\u0026qs=13\u0026rc=amp2Ojg6Zm9kZjQzNGg7M0Bpamp2Ojg6Zm9kZjQzNGg7M0AvZl5rcjRfX29gLS1kMDBzYSMvZl5rcjRfX29gLS1kMDBzcw%3D%3D\u0026l=202209301613190102120910910545813E"
    },
    "message":"Success",
    "request_id":"20220928160139010210058164043A3882",
    "status":10000,
    "time_elapsed":"36.407136ms"
}

错误码

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

（2）业务错误码

http code	错误码	错误信息	说明
200	10000	Success	成功

测试与费用说明

说明

异步调用方式-任务提交

接口简介

限制条件

请求说明

输出说明

错误码

异步调用方式-任务查询

接口简介

请求说明

输出说明

错误码

【已废弃】同步调用方式

同步调用方式已废弃，请参考上文使用异步方式进行调用。

请求说明

输出说明

错误码

视频技术

调用方式（按量计费）

测试与费用说明

说明

接口简介

限制条件

请求说明

输出说明

错误码

接口简介

请求说明

输出说明

错误码

同步调用方式已废弃，请参考上文使用异步方式进行调用。

请求说明

输出说明

错误码