1. 接口描述
接口请求域名: facefusion.tencentcloudapi.com 。
本接口用于单脸、多脸、选脸融合,上传人脸图片,得到与素材模板融合后的人脸图片。支持为融合结果图添加标识。查看 融合接入指引。
请求频率限制为20次/秒。
- 公共参数中的签名方式必须指定为V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:FuseFace。 |
Version | 是 | String | 公共参数,本接口取值:2022-09-27。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ProjectId | 是 | String | 活动 ID,请在人脸融合控制台查看。 示例值:300029 |
ModelId | 是 | String | 素材 ID,请在人脸融合控制台查看。 示例值:qc_300029_453345_1 |
RspImgType | 是 | String | 返回图像方式(url 或 base64) ,二选一。url有效期为7天。 示例值:url |
MergeInfos.N | 是 | Array of MergeInfo | 用户人脸图片、素材模板图的人脸位置信息。不能超过6个。 示例值:[] |
FuseProfileDegree | 否 | Integer | 脸型融合比例,数值越高,融合后的脸型越像素材人物。取值范围[0,100] 若此参数不填写,则使用人脸融合控制台中脸型参数数值。(换脸版算法暂不支持此参数调整) 示例值:1 |
FuseFaceDegree | 否 | Integer | 五官融合比例,数值越高,融合后的五官越像素材人物。取值范围[0,100] 若此参数不填写,则使用人脸融合控制台中五官参数数值。(换脸版算法暂不支持此参数调整) 示例值:1 |
LogoAdd | 否 | Integer | 为融合结果图添加合成标识的开关,默认为1。 1:添加标识。 0:不添加标识。 其他数值:默认按1处理。 建议您使用显著标识来提示结果图使用了人脸融合技术,是AI合成的图片。 示例值:1 |
LogoParam | 否 | LogoParam | 标识内容设置。 默认在融合结果图右下角添加“本图片为AI合成图片”字样,您可根据自身需要替换为其他的Logo图片。 示例值:{} |
FuseParam | 否 | FuseParam | 融合参数。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
FusedImage | String | RspImgType 为 url 时,返回结果的 url(有效期7天), RspImgType 为 base64 时返回 base64 数据。 示例值:http://cloud.com/result.png |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 选脸融合
输入示例
POST / HTTP/1.1
Host: facefusion.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: FuseFace
<公共请求参数>
{
"LogoParam": {
"LogoRect": {
"Y": 0,
"X": 0,
"Height": 0,
"Width": 0
},
"LogoUrl": "test1.jpg"
},
"ProjectId": "at_1603326187690926080",
"LogoAdd": 1,
"RspImgType": "url",
"MergeInfos": [
{
"Url": "test.jpg",
"TemplateFaceID": "mt_1603586676924403712_1"
}
],
"ModelId": "mt_1603586676924403712"
}
输出示例
{
"Response": {
"FusedImage": "result.jpg",
"RequestId": "1a2e88a4-3614-48a0-96b9-d09bf6de2fe4"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.BalanceInsufficient | 余额不足,开通失败,请充值后再开通。 |
FailedOperation.FaceSizeTooSmall | 人脸因太小被过滤,建议人脸分辨率不小于34*34。 |
FailedOperation.FuseMaterialNotAuth | 素材未经过审核。 |
FailedOperation.FuseMaterialNotExist | 素材不存在。 |
FailedOperation.ImageDecodeFailed | 人脸检测-图片解码失败。 |
FailedOperation.ImageDownloadError | 图片下载失败。 |
FailedOperation.ImageResolutionTooSmall | 图片短边分辨率小于64。 |
FailedOperation.ImageSizeExceed | 输入图片base64数据大小超过5M。 |
FailedOperation.ImageSizeInvalid | 图片尺寸过大或者过小;不满足算法要求。 |
FailedOperation.InnerError | 服务内部错误。 |
FailedOperation.NoFaceDetected | 无法检测出人脸, 人脸框配准分低于阈值。 |
FailedOperation.ParameterValueError | 参数字段或者值有误。 |
FailedOperation.RequestTimeout | 后端服务超时。 |
FailedOperation.RpcFail | RPC请求失败,一般为算法微服务故障。 |
FailedOperation.TemplateFaceIDNotExist | 素材人脸ID不存在。 |
FailedOperation.UnKnowError | 内部错误。 |
FailedOperation.Unknown | 未知错误。 |
InvalidParameterValue.ActivityIdNotFound | 未查找到活动id。 |
InvalidParameterValue.FaceRectParameterValueError | 人脸框参数有误或者人脸框太小。 |
InvalidParameterValue.MaterialIdNotFound | 未查找到素材Id。 |
InvalidParameterValue.UrlIllegal | URL格式不合法。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable.Freeze | 账号已被冻结。 |
ResourceUnavailable.InArrears | 账号已欠费。 |
ResourceUnavailable.IsOpening | 服务正在开通中,请稍等。 |
ResourceUnavailable.NotExist | 计费状态未知,请确认是否已在控制台开通服务。 |
ResourceUnavailable.Recover | 资源已被回收。 |
ResourceUnavailable.StopUsing | 账号已停服。 |