1. 接口描述
接口请求域名： aiart.tencentcloudapi.com 。
AI 写真提供 AI 写真形象照的训练与生成能力，分为上传训练图片、训练模型、生成图片3个环节，需要依次调用对应接口。
每个写真模型自训练完成起1年内有效，有效期内可使用写真模型 ID 生成图片，期满后需要重新训练。
生成图片分为提交任务和查询任务2个接口。
- 提交生成写真图片任务：完成训练写真模型后，选择风格模板，提交一个生成写真图片异步任务，根据写真模型 ID 开始生成人物形象在指定风格上的写真图片，获得任务 ID。
- 查询生成写真图片任务：根据任务 ID 查询生成图片任务的处理状态、处理结果。
提交生成写真图片任务默认提供1个并发任务数。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：SubmitDrawPortraitJob。 |
| Version | 是 | String | 公共参数，本接口取值：2022-12-29。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ModelId | 是 | String | 写真模型 ID。 示例值：abcde |
| StyleId | 是 | String | 写真风格模板。 请在 AI 写真风格列表 中选择期望的风格，传入风格编号。 示例值：zhengjian_female |
| ImageNum | 是 | Integer | 本次生成的图片数量，取值范围[1,4] |
| LogoAdd | 否 | Integer | 为生成结果图添加标识的开关，默认为1。 1：添加标识。 0：不添加标识。 其他数值：默认按1处理。 建议您使用显著标识来提示结果图是 AI 生成的图片。 示例值：1 |
| LogoParam | 否 | LogoParam | 标识内容设置。 默认在生成结果图右下角添加“图片由 AI 生成”字样，您可根据自身需要替换为其他的标识图片。 |
| Definition | 否 | String | 清晰度，支持以下选项： sd：基础版，分辨率512:640 hd：高清畅享版，分辨率1024:1280 hdpro：高清优享版，分辨率1024:1280（推荐） uhd：超清版，分辨率2048:2560 不填默认为sd。 示例值：sd |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| JobId | String | 提交生成写真图片任务 ID。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功
调用成功
输入示例
POST / HTTP/1.1
Host: aiart.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SubmitDrawPortraitJob
<公共请求参数>
{
"ModelId": "test",
"StyleId": "zhengjian_female",
"ImageNum": 1
}输出示例
{
"Response": {
"JobId": "abcdefg",
"RequestId": "94b5192b-b40b-4f0c-b4f8-edfa7092f8b9"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.InvalidParameter | 参数不合法。 |
| RequestLimitExceeded.JobNumExceed | 同时处理的任务数过多，请稍后重试。 |
| ResourcesSoldOut.ChargeStatusException | 计费状态异常。 |