1. 接口描述
接口请求域名: aiart.tencentcloudapi.com 。
混元生图接口,基于混元大模型,根据输入的文本描述快速生成图片。
默认提供1个并发,代表最多能同时处理1个已提交的任务,上一个任务处理完毕后,才能开始处理下一个任务。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:SubmitTextToImageJob。 |
| Version | 是 | String | 公共参数,本接口取值:2022-12-29。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| Prompt | 是 | String | 文本描述。 示例值:雨中, 竹林, 小路 |
| Images.N | 否 | Array of String | 垫图url列表,大小不超过10MB,支持 jpg jpeg png webp格式,最多3张图 示例值:["https://xxx.jpeg"] |
| Resolution | 否 | String | 生成图分辨率,默认1024:1024:
示例值:1024:1024 |
| Seed | 否 | Integer | 随机种子,默认随机。 示例值:148237123 |
| LogoAdd | 否 | Integer | 为生成结果图添加显式水印标识的开关,默认为1。 示例值:1 |
| LogoParam | 否 | LogoParam | 标识内容设置。 |
| Revise | 否 | Integer | 是否开启prompt改写,为空时默认开启,改写预计会增加20s左右耗时。 示例值:0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| JobId | String | 任务 ID。 示例值:1259388371-1764399486-fd7b5e60-b633-11f0-827b-52540087afa5-0 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 正常调用场景
输入示例
POST / HTTP/1.1
Host: aiart.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SubmitTextToImageJob
<公共请求参数>
{
"Prompt": "生成一张配图**一个日历显示‘Monday’,旁边有一个闹钟指向7:00,窗外阳光明媚代表早晨,书包放在桌边。画面无文字。**;\\n风格要求:**真实风格**,色彩鲜亮、温暖、饱和度高。\\n画面细节:线条简洁流畅,背景柔和,聚焦主体。\\n视觉效果:摄影风,适合儿童教学用途。\\n\\n要求点:\\n- 如果涉及人物的话,人物形象积极健康,充满活力和阳光感;\\n- 图片中的场景、人物都必须是真实世界的事物,不要出现幻想、想象、虚拟等非真实世界的事物;\\n- 图片不得包含任何文本(数字、单词、符号、句子等),如果上面提示词有的话,也要去掉;\\n- 图片内容必须精准匹配描述,避免错误元素(如逻辑不符,图片表示跳出箱子、正确项却为跳进箱子);\\n- 生成注意符合生活常识(如太阳应出现在室外,而不是房间里面,如大象出现在野外,不在桌子上);\\n- 涉及到钟表显示,使用电子表,不要使用指针钟表;\\n- 图片中的元素比较精简,不要堆砌多个元素、模糊重点;",
"Resolution": "1248:832",
"Revise": 0
}
输出示例
{
"Response": {
"JobId": "251197765-1769741457-80b5b8df-fd86-11f0-ad04-525400647112-0",
"RequestId": "ee8f21db-e724-4333-8130-e0520ac73e4f"
}
}
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 | 计费状态异常。 |