1. 接口描述
接口请求域名： aiart.tencentcloudapi.com 。
提交图片特效任务
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：SubmitTemplateToImageJob。 |
| Version | 是 | String | 公共参数，本接口取值：2022-12-29。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Image | 是 | Image | 算法将根据输入的图片，结合文本描述智能生成与之相关的图像。 Base64 和 Url 必须提供一个，如果都提供以 Url 为准。 图片限制：单边分辨率小于5000且大于50，转成 Base64 字符串后小于 8MB，格式支持 jpg、jpeg、png、bmp、tiff、webp。 |
| Style | 否 | String | 绘画风格当前仅支持美术馆风格（gallerying）。 示例值：gallerying |
| Mode | 否 | String | 特效模式，默认使用人像模式。 Person：人像模式，仅支持上传人像图片，人像生成效果更好【这里需要加非人脸的拦截】。 Pet：宠物模式，支持宠物等非人像图片。 示例值：Person 示例值：Person |
| LogoAdd | 否 | Integer | 为生成结果图添加显式水印标识的开关，默认为1。 1：添加。 0：不添加。 其他数值：默认按1处理。 建议您使用显著标识来提示结果图使用了 AI 绘画技术，是 AI 生成的图片。 示例值：1 |
| LogoParam | 否 | LogoParam | 标识内容设置。 默认在生成结果图右下角添加“图片由 AI 生成”字样，您可根据自身需要替换为其他的标识图片。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| JobId | String | 任务 ID。 示例值：1394637692053602304 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 调用成功示例
输入示例
POST / HTTP/1.1
Host: aiart.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SubmitTemplateToImageJob
<公共请求参数>
{
"Image": {
"Url": "https://test.com/1.png"
},
"Style": "gallerying",
"LogoAdd": 1
}输出示例
{
"Response": {
"JobId": "1394637692053602304",
"RequestId": "b1759140-6951-4d6a-9f12-add42ca16b25"
}
}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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.UnauthorizedOperation | 无权执行该操作，请检查您的CAM策略，确保您拥有对应的CAM权限。 |
| FailedOperation.ConsoleServerError | 控制台服务异常。 |
| FailedOperation.GenerateImageFailed | 生成图片审核不通过，请重试。 |
| FailedOperation.ImageDecodeFailed | 图片解码失败。 |
| FailedOperation.ImageDownloadError | 图片下载错误。 |
| FailedOperation.InnerError | 服务内部错误，请稍后重试。 |
| FailedOperation.RequestEntityTooLarge | 整个请求体太大（通常主要是图片）。 |
| FailedOperation.RequestTimeout | 后端服务超时。 |
| FailedOperation.RpcFail | RPC请求失败，一般为算法微服务故障。 |
| FailedOperation.ServerError | 服务内部错误。 |
| FailedOperation.Unknown | 未知错误。 |
| InvalidParameter.InvalidParameter | 参数不合法。 |
| InvalidParameterValue.ImageEmpty | 图片为空。 |
| InvalidParameterValue.LogoParamErr | 当前引擎不支持自定义水印。 |
| InvalidParameterValue.ParameterValueError | 参数字段或者值有误 |
| InvalidParameterValue.TextLengthExceed | 输入文本过长，请更换短一点的文本后重试。 |
| InvalidParameterValue.UrlIllegal | URL格式不合法。 |
| OperationDenied.ImageIllegalDetected | 图片包含违法违规信息，审核不通过。 |
| OperationDenied.TextIllegalDetected | 文本包含违法违规信息，审核不通过。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| RequestLimitExceeded.JobNumExceed | 同时处理的任务数过多，请稍后重试。 |
| ResourceUnavailable.InArrears | 账号已欠费。 |
| ResourceUnavailable.LowBalance | 余额不足。 |
| ResourceUnavailable.NotExist | 计费状态未知，请确认是否已在控制台开通服务。 |
| ResourceUnavailable.StopUsing | 账号已停服。 |
| ResourcesSoldOut.ChargeStatusException | 计费状态异常。 |
