You need to enable JavaScript to run this app.
导航

接口文档

最近更新时间2022.08.01 17:20:42

首次发布时间2021.02.23 10:42:15

接入指引

请先查看接入指引了解具体接入方式,再参考此文档完成接入。

请求API

名称内容
请求方式POST
Content-Typeapplication/x-www-form-urlencoded
图片要求图片格式:JPG(JPEG), PNG, BMP 等常见格式, 建议使用JPG格式.
目标图片要求
1. 图片像素尺寸:最小 50 x 50 像素,最大 2048 x 2048 像素
2. 不支持黑白图片
3. 图片文件大小:最大 2 MB
4. 人脸像素尺寸:为了保证融合效果,推荐图片中人脸框(正方形)边长的最小值不低于200像素。
5. 人脸质量:人脸质量越高,则融合效果越好。
6. 影响人脸质量的因素包括:对人脸五官的遮挡、不当的光照(强光、暗光、逆光)、过大的人脸角度(推荐 yaw ≤ ±20°, pitch ≤ ±20°)等。
模版要求:
1. 素材需要有版权, 有肖像权, 没有法律或者政策风险的. 相关风险请注意评估.
2. 注意对于脸部比较特殊的素材, 如眼睛过大等卡通风格的图片, 原始关键点的结果会出现偏差, 应该在配置工具中通过拖动使得位置准确. 大部分正常图片原始结果已经非常准确, 不需要调整.
3. 注意素材图片只能为JPG, 图片像素宽高不宜过大, 模板图最长边强制不能超过 1280.
4. 图片中脸部像素面积不宜过小(至少200*200, 过小换脸会不清晰), 也不宜过大(脸部面积像素大小和速度正相关, 过大会影响服务器速度, 提高成本).
5. 注意素材质量, 保证脸部足够清晰, 不应该有因为压缩导致的噪声, 否则会降低换脸结果图质量
6. 为了更好的效果,素材脸部应该尽可能正脸,yaw角度要求最高(建议正负10度内),pitch角度其次(建议正负20度内),roll角度(正负30度内)。

输入参数

Query参数:

参数可选/必选类型说明
Action必选String接口名,取值:FaceSwap
Version必选String版本号,取值:2020-08-26

Body参数:

参数可选/必选类型说明
image_base64必选String图片文件,base64编码
template_base64必选String模版文件,base64编码
action_id必选String固定取值:faceswap
version可选String人脸融合版本。可选值:
1.0:基础版,不建议使用,陆续迁移下线
2.0:进阶版,强烈建议使用,效果更好
不传则默认为1.0

API返回

通用返回字段说明

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

data 字段说明

字段类型说明备注
imagestring变换后的图像,返回图片的Base64编码

错误码

HttpCode错误码错误消息描述
20010000请求成功
40060103"Missing Input Parameters: empty input image"输入图片为空
40060201"Invalid Input Image: get input image error"图像解析错误
40060203"Missing Input Parameters: empty input template"输入模版图片为空
40060204"Invalid Input Image: no face detected in image"未检测到人脸
40060102"Invalid Input Image: no face detected in image"未检测到人脸
40060208"Invalid Input Image: input image contain sensitive contents"上传图片包含敏感信息
40060209"FaceSwap error: {error message}"人脸融合错误,具体见错误信息

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

返回值示例

{
    "code":10000,
    "data":{
        "image": "",
    },
    "message":"Success",
    "request_id":"6838889517957515275",
    "time_elapsed":"41.897331ms"
}