1. 接口描述
接口请求域名: fmu.tencentcloudapi.com 。
用户上传一张人脸图片(最多能处理一张图片中最大的五张人脸信息),精准定位五官,实现美肤、亮肤、祛痘等美颜功能。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:BeautifyPic。 |
Version | 是 | String | 公共参数,本接口取值:2019-12-13。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Image | 否 | String | 图片 base64 数据,base64 编码后大小不可超过5M。 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。 示例值:/9j/4AAQSkZJRgABAQAAAQABAAD/4gIo...lftXF/DjFZNXoSP5V2U0HMt/1FQf/Z |
Url | 否 | String | 图片的 Url 。对应图片 base64 编码后大小不可超过5M。 Url、Image必须提供一个,如果都提供,只使用 Url。 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。 非腾讯云存储的Url速度和稳定性可能受一定影响。 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。 示例值:https://liudehua-9527.cos.ap-guangzhou.myqcloud.com/input.jpeg |
Whitening | 否 | Integer | 美白程度,取值范围[0,100]。0不美白,100代表最高程度。默认值30。 示例值:1 |
Smoothing | 否 | Integer | 磨皮程度,取值范围[0,100]。0不磨皮,100代表最高程度。默认值10。 示例值:1 |
FaceLifting | 否 | Integer | 瘦脸程度,取值范围[0,100]。0不瘦脸,100代表最高程度。默认值70。 示例值:1 |
EyeEnlarging | 否 | Integer | 大眼程度,取值范围[0,100]。0不大眼,100代表最高程度。默认值70。 示例值:1 |
RspImgType | 否 | String | 返回图像方式(base64 或 url ) ,二选一。url有效期为1天。 示例值:base64 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ResultImage | String | RspImgType 为 base64 时,返回处理后的图片 base64 数据。默认返回base64 注意:此字段可能返回 null,表示取不到有效值。 示例值:/9j/4AAQSkZJRgABAQAAAQABAAD/4gIo...lftXF/DjFZNXoSP5V2U0HMt/1FQf/Z |
ResultUrl | String | RspImgType 为 url 时,返回处理后的图片 url 数据。 注意:此字段可能返回 null,表示取不到有效值。 示例值:https://liudehua-9527.cos.ap-guangzhou.myqcloud.com/result.jpeg?q-sign-algorithm=sha1&q-ak=AKID********EXAMPLE&q-sign-time=8888;9999&q-key-time=8888;9999&q-header-list=&q-url-param-list=&q-signature=7de87f7bf9cfd23df9da32f46661e7cf97a5603c |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 人脸美颜请求示例
人脸美颜请求
输入示例
POST / HTTP/1.1
Host: fmu.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: BeautifyPic
<公共请求参数>
{
"Url": "https://liudehua-9527.cos.ap-guangzhou.myqcloud.com/input.jpeg",
"RspImgType": "url"
}
输出示例
{
"Response": {
"ResultUrl": "https://liudehua-9527.cos.ap-guangzhou.myqcloud.com/result.jpeg?q-sign-algorithm=sha1&q-ak=AKID********EXAMPLE&q-sign-time=8888;9999&q-key-time=8888;9999&q-header-list=&q-url-param-list=&q-signature=7de87f7bf9cfd23df9da32f46661e7cf97a5603c",
"ResultImage": "",
"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.BeautifyFailed | 图片美颜失败,请更换图片。 |
FailedOperation.FaceSizeTooSmall | 人脸因太小被过滤,建议人脸分辨率不小于34*34。 |
FailedOperation.ImageDecodeFailed | 图片解码失败。 |
FailedOperation.ImageDownloadError | 图片下载失败。 |
FailedOperation.ImageNotSupported | 不支持的图片文件。 |
FailedOperation.ImageResolutionExceed | 图片分辨率过大,超过2000*2000。 |
FailedOperation.ImageResolutionTooSmall | 图片短边分辨率小于64。 |
FailedOperation.ImageSizeExceed | 图片数据太大。 |
FailedOperation.InnerError | 服务内部错误,请重试。 |
FailedOperation.RequestEntityTooLarge | 请求包体太大,建议在6M内(通常是参数中包括大的图片)。 |
FailedOperation.RequestTimeout | 后端服务超时,请重试。 |
FailedOperation.RpcFail | RPC请求失败,一般为算法微服务故障。 |
FailedOperation.ServerError | 系统内部错误。 |
FailedOperation.Unknown | 未知错误。 |
InvalidParameter.InvalidParameter | 参数不合法。 |
InvalidParameter.NoFaceInPhoto | 图片中没有人脸。 |
InvalidParameterValue.EyeEnlargingIllegal | 大眼参数不合法。 |
InvalidParameterValue.FaceLiftingIllegal | 瘦脸参数不合法。 |
InvalidParameterValue.ImageEmpty | 缺少参数,请检查图片参数是否为空。 |
InvalidParameterValue.ImageInvalid | 图片不合法。 |
InvalidParameterValue.NoFaceInPhoto | 图片中没有人脸。 |
InvalidParameterValue.SmoothingIllegal | 磨皮参数不合法。 |
InvalidParameterValue.UrlIllegal | URL格式不合法。 |
InvalidParameterValue.WhiteningIllegal | 美白参数不合法。 |
ResourceUnavailable.Delivering | 资源正在发货中。 |
ResourceUnavailable.Freeze | 账号已被冻结。 |
ResourceUnavailable.GetAuthInfoError | 获取认证信息失败。 |
ResourceUnavailable.InArrears | 账号已欠费。 |
ResourceUnavailable.LowBalance | 余额不足。 |
ResourceUnavailable.NotReady | 服务未开通。 |
ResourceUnavailable.Recover | 资源已被回收。 |
ResourceUnavailable.StopUsing | 账号已停服。 |
ResourceUnavailable.UnknownStatus | 计费状态未知。 |
ResourcesSoldOut.ChargeStatusException | 账号已欠费。 |