大模型图像创作引擎百变头像-图像风格化相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： aiart.tencentcloudapi.com 。

百变头像接口将根据输入的人像照片，生成风格百变的头像。
百变头像默认提供1个并发任务数，代表最多能同时处理1个已提交的任务，上一个任务处理完毕后才能开始处理下一个任务。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：GenerateAvatar。
Version	是	String	公共参数，本接口取值：2022-12-29。
Region	是	String	公共参数，详见产品支持的地域列表。
Style	是	String	头像风格。请在百变头像风格列表中选择期望的风格，必须传入风格编号。
InputImage	否	String	输入图 Base64 数据。算法将根据输入的图片，结合文本描述智能生成与之相关的图像。 Base64 和 Url 必须提供一个，如果都提供以 Base64 为准。图片限制：单边分辨率小于5000，转成 Base64 字符串后小于 6MB，格式支持 jpg、jpeg、png、bmp、tiff、webp。
InputUrl	否	String	输入图 Url。算法将根据输入的图片，结合文本描述智能生成与之相关的图像。 Base64 和 Url 必须提供一个，如果都提供以 Base64 为准。图片限制：单边分辨率小于5000，转成 Base64 字符串后小于 6MB，格式支持 jpg、jpeg、png、bmp、tiff、webp。
Filter	否	Integer	输入图像质量检测开关，默认开启。 1：开启 0：关闭建议开启检测，可提升生成效果，关闭检测可能因输入图像质量较差导致生成效果受损。开启后，将增强对输入图像的质量要求，如果输入图像单边分辨率<500、图像中人脸占比较小、存在多人、没有检测到人脸、人脸不完整、人脸遮挡等，将被拦截。关闭后，将降低对输入图像的质量要求，如果图像中没有检测到人脸或人脸占比过小等，将被拦截。
LogoAdd	否	Integer	为生成结果图添加标识的开关，默认为1。 1：添加标识。 0：不添加标识。其他数值：默认按1处理。建议您使用显著标识来提示结果图是 AI 生成的图片。
LogoParam	否	LogoParam	标识内容设置。默认在生成结果图右下角添加“图片由 AI 生成”字样，您可根据自身需要替换为其他的标识图片。
RspImgType	否	String	返回图像方式（base64 或 url) ，二选一，默认为 base64。url 有效期为1小时。示例值：base64

3. 输出参数

参数名称	类型	描述
ResultImage	String	根据入参 RspImgType 填入不同，返回不同的内容。如果传入 base64 则返回生成图 Base64 编码。如果传入 url 则返回的生成图 URL , 有效期1小时，请及时保存。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 调用成功示例

输入示例

POST / HTTP/1.1
Host: aiart.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GenerateAvatar
<公共请求参数>

{
    "InputUrl": "http://url",
    "Style": "water"
}

输出示例

{
    "Response": {
        "ResultImage": "url or base64",
        "RequestId": "301bfc25-61ca-4ece-b03e-f6aefb547969"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure.UnauthorizedOperation	无权执行该操作，请检查您的CAM策略，确保您拥有对应的CAM权限。
FailedOperation.GenerateImageFailed	生成图片审核不通过，请重试。
FailedOperation.ImageDecodeFailed	图片解码失败。
FailedOperation.ImageDownloadError	图片下载错误。
FailedOperation.ImageResolutionExceed	图片分辨率过大，超过2000*2000。
FailedOperation.ImageSizeExceed	base64编码后的图片数据大小不超过10M。
FailedOperation.InnerError	服务内部错误，请稍后重试。
FailedOperation.RequestEntityTooLarge	整个请求体太大（通常主要是图片）。
FailedOperation.RequestTimeout	后端服务超时。
FailedOperation.RpcFail	RPC请求失败，一般为算法微服务故障。
FailedOperation.ServerError	服务内部错误。
FailedOperation.Unknown	未知错误。
InvalidParameter.InvalidParameter	参数不合法。
InvalidParameterValue.ImageEmpty	图片为空。
InvalidParameterValue.ParameterValueError	参数字段或者值有误
InvalidParameterValue.StyleConflict	1xx和其他风格不可混合使用。
InvalidParameterValue.TextLengthExceed	输入文本过长，请更换短一点的文本后重试。
InvalidParameterValue.UrlIllegal	URL格式不合法。
OperationDenied.ImageIllegalDetected	图片包含违法违规信息，审核不通过。
OperationDenied.TextIllegalDetected	文本包含违法违规信息，审核不通过。
RequestLimitExceeded	请求的次数超过了频率限制。
RequestLimitExceeded.JobNumExceed	同时处理的任务数过多，请稍后重试。
ResourceUnavailable.Delivering	资源正在发货中。
ResourceUnavailable.InArrears	账号已欠费。
ResourceUnavailable.LowBalance	余额不足。
ResourceUnavailable.NotExist	计费状态未知，请确认是否已在控制台开通服务。
ResourceUnavailable.StopUsing	账号已停服。
ResourcesSoldOut.ChargeStatusException	计费状态异常。