1. 接口描述
接口请求域名: aiart.tencentcloudapi.com 。
本接口已迁移至腾讯混元大模型-混元生图,即将停止此处维护,可切换至 混元生图 API 继续使用。
文生图(高级版)接口基于高级版文生图大模型,将根据输入的文本描述,智能生成与之相关的结果图。分为提交任务和查询任务2个接口。
提交任务:输入文本等,提交一个文生图(高级版)异步任务,获得任务 ID。
查询任务:根据任务 ID 查询任务的处理状态、处理结果,任务处理完成后可获得生成图像结果。
并发任务数(并发)说明:并发任务数指能同时处理的任务数量。文生图(高级版)默认提供1个并发任务数,代表最多能同时处理1个已提交的任务,上一个任务处理完毕后才能开始处理下一个任务。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:QueryTextToImageProJob。 |
Version | 是 | String | 公共参数,本接口取值:2022-12-29。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
JobId | 是 | String | 任务 ID。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
JobStatusCode | String | 当前任务状态码: 1:等待中、2:运行中、4:处理失败、5:处理完成。 |
JobStatusMsg | String | 当前任务状态:排队中、处理中、处理失败或者处理完成。 |
JobErrorCode | String | 任务处理失败错误码。 |
JobErrorMsg | String | 任务处理失败错误信息。 |
ResultImage | Array of String | 生成图 URL 列表,有效期1小时,请及时保存。 |
ResultDetails | Array of String | 结果 detail 数组,Success 代表成功。 |
RevisedPrompt | Array of String | 对应 SubmitTextToImageProJob 接口中 Revise 参数。开启扩写时,返回扩写后的 prompt 文本。 如果关闭扩写,将直接返回原始输入的 prompt。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功调用
成功调用
输入示例
POST / HTTP/1.1
Host: aiart.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: QueryTextToImageProJob
<公共请求参数>
{
"JobId": "testJobId"
}
输出示例
{
"Response": {
"JobErrorCode": "",
"JobErrorMsg": "",
"JobStatusCode": "5",
"JobStatusMsg": "处理完成",
"RequestId": "fae816f9-7fd1-4e39-bf1c-3d43677603de",
"ResultDetails": [
"Success"
],
"ResultImage": [
"https://test.jpg"
]
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.JobNotExist | 任务不存在。 |
FailedOperation.ServerError | 服务内部错误。 |
OperationDenied.ImageIllegalDetected | 图片包含违法违规信息,审核不通过。 |