1. 接口描述
接口请求域名: aiart.tencentcloudapi.com 。
AI 美照接口将根据模板为用户生成精美照片。分为提交任务和查询任务2个接口。
- 提交任务:提交一个美照生成异步任务,获得任务 ID。
- 查询任务:根据任务 ID 查询任务的处理状态、处理结果,任务处理完成后可获得生成图像结果。
AI 美照默认提供1个并发,代表最多能同时处理1个已提交的任务,上一个任务处理完毕后才能开始处理下一个任务。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:SubmitGlamPicJob。 |
Version | 是 | String | 公共参数,本接口取值:2022-12-29。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
TemplateUrl | 是 | String | 美照模板图 URL。 图片限制:模板图中最多出现5张人脸,单边分辨率大于300,转成 Base64 字符串后小于 10MB,格式支持 jpg、jpeg、png、bmp、tiff、webp。 示例值:https://xxx.com/image.jpg |
FaceInfos.N | 否 | Array of FaceInfo | 用户图 URL 列表,以及模板图中需要替换成用户的人脸框信息。 一张美照中可包含1 ~ 5个用户形象。每个用户需上传1 ~ 6张照片,如果图中存在多个人脸将取最大人脸。 模板图中的人脸数量需要大于等于用户个数。如果不传每个用户在模板图中的人脸框位置,默认按照模板图人脸框从大到小的顺序进行替换。如需自定义顺序,需要依次上传每个用户在模板图中的人脸框位置。 图片限制:每张图片转成 Base64 字符串后小于 10MB,格式支持 jpg、jpeg、png、bmp、tiff、webp。建议使用单人、正脸、脸部区域占比较大、脸部清晰无遮挡、无大角度偏转、无夸张表情的用户图。 示例值:[ { "ImageUrls": [ "https://xxx.com/image.jpg" ] } ] |
Num | 否 | Integer | 美照生成数量。 支持1 ~ 4张,默认生成4张。 示例值:4 |
Style.N | 否 | Array of String | 美照生成风格。 仅对单人美照生效,单人可支持选择不同风格。需按照美照生成数量,在数组中逐一填入每张美照的风格名称。如果不传,默认取不重复的随机风格顺序。 多人美照只支持 balanced 一种风格,该参数不生效。 可选风格:
示例值:["real", "balanced", "textured", "beautiful"] |
Similarity | 否 | Float | 相似度系数,越高越像用户图。 取值范围[0, 1],默认为0.6。 示例值:0.6 |
Clarity | 否 | String | 超分选项,默认不做超分,可选开启。 x2:2倍超分 x4:4倍超分 示例值:x2 |
LogoAdd | 否 | Integer | 为生成结果图添加标识的开关,默认为1。 1:添加标识。 0:不添加标识。 其他数值:默认按1处理。 建议您使用显著标识来提示结果图是 AI 生成的图片。 示例值:1 |
LogoParam | 否 | LogoParam | 标识内容设置。 默认在生成结果图右下角添加“图片由 AI 生成”字样,您可根据自身需要替换为其他的标识图片。 示例值:{"LogoUrl": "https://xxx.com/logo.jpg", "LogoRect": {"X": 10, "Y": 10, "Width": 20, "Height": 20}} |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
JobId | String | 任务ID。 示例值:251197749-1732000778-a319cc1b-a646-11ef-be80-525400047e59-0 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 提交美照任务
输入示例
POST / HTTP/1.1
Host: aiart.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SubmitGlamPicJob
<公共请求参数>
{
"TemplateUrl": "https://xxx.com/template.jpg",
"FaceInfos": [
{
"ImageUrls": [
"https://xxx.com/input.jpg"
]
}
],
"Num": 1,
"Similarity": 0.6
}
输出示例
{
"Response": {
"JobId": "251197749-1739859949-31f02502-edc1-11ef-a849-525400c5aaa8-0",
"RequestId": "d878c2e1-7108-40b5-aecf-4fb37a6e5695"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。