1. 接口描述
接口请求域名: aiart.tencentcloudapi.com 。
本接口已迁移至腾讯混元大模型-混元生图,即将停止此处维护,可切换至 混元生图 API 继续使用。
文生图(高级版)接口基于高级版文生图大模型,将根据输入的文本描述,智能生成与之相关的结果图。分为提交任务和查询任务2个接口。
提交任务:输入文本等,提交一个文生图(高级版)异步任务,获得任务 ID。
查询任务:根据任务 ID 查询任务的处理状态、处理结果,任务处理完成后可获得生成图像结果。
并发任务数(并发)说明:并发任务数指能同时处理的任务数量。文生图(高级版)默认提供1个并发任务数,代表最多能同时处理1个已提交的任务,上一个任务处理完毕后才能开始处理下一个任务。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:SubmitTextToImageProJob。 |
Version | 是 | String | 公共参数,本接口取值:2022-12-29。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Prompt | 是 | String | 文本描述。 算法将根据输入的文本智能生成与之相关的图像。 不能为空,推荐使用中文。最多可传100个 utf-8 字符。 示例值:雨中, 竹林, 小路 |
Style | 否 | String | 绘画风格。 请在 文生图(高级版)风格列表 中选择期望的风格,传入风格编号。 不传默认不指定风格。 |
Resolution | 否 | String | 生成图分辨率。 支持生成以下分辨率的图片:768:768(1:1)、768:1024(3:4)、1024:768(4:3)、1024:1024(1:1)、720:1280(9:16)、1280:720(16:9)、768:1280(3:5)、1280:768(5:3),不传默认使用1024:1024。 |
LogoAdd | 否 | Integer | 为生成结果图添加显式水印标识的开关,默认为1。 1:添加。 0:不添加。 其他数值:默认按1处理。 建议您使用显著标识来提示结果图使用了 AI 绘画技术,是 AI 生成的图片。 |
Engine | 否 | String | 文生图模型,默认使用engine1。 取值: engine1 engine2 |
Revise | 否 | Integer | prompt 扩写开关。1为开启,0为关闭,不传默认开启。 开启扩写后,将自动扩写原始输入的 prompt 并使用扩写后的 prompt 生成图片,返回生成图片结果时将一并返回扩写后的 prompt 文本。 如果关闭扩写,将直接使用原始输入的 prompt 生成图片。 建议开启,在多数场景下可提升生成图片效果、丰富生成图片细节。 |
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: SubmitTextToImageProJob
<公共请求参数>
{
"Prompt": "雨天",
"Style": "dongman"
}
输出示例
{
"Response": {
"JobId": "testJobId",
"RequestId": "aeb78554-0772-4c64-8a84-fa21095cbbd7"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
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 | 计费状态异常。 |