1. 接口描述
接口请求域名: hunyuan.tencentcloudapi.com 。
混元生图(多轮对话)接口基于混元大模型,将根据输入的文本描述生成图像,支持通过多轮对话的方式不断调整图像内容。分为提交任务和查询任务2个接口。
提交任务:输入文本和前置对话 ID 等,提交一个混元生图多轮对话异步任务,获得任务 ID。
查询任务:根据任务 ID 查询任务的处理状态、处理结果,任务处理完成后可获得在上一轮对话基础上继续生成的图像结果。
混元生图(多轮对话)默认提供1个并发任务数,代表最多能同时处理1个已提交的任务,上一个任务处理完毕后才能开始处理下一个任务。
                推荐使用 API Explorer
            
            点击调试
        
                API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
            
        2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 | 
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:QueryHunyuanImageChatJob。 | 
| Version | 是 | String | 公共参数,本接口取值:2023-09-01。 | 
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou 。 | 
| JobId | 否 | String | 任务 ID。 示例值:1253534368-1731657099-7276788a-a326-11ef-beeb-525400bba60c-0 | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| JobStatusCode | String | 当前任务状态码: 1:等待中、2:运行中、4:处理失败、5:处理完成。 示例值:5 | 
| JobStatusMsg | String | 当前任务状态:排队中、处理中、处理失败或者处理完成。 示例值:处理完成 | 
| JobErrorCode | String | 任务处理失败错误码。 示例值:FailedOperation.DownloadError | 
| JobErrorMsg | String | 任务处理失败错误信息。 示例值:文件下载失败。 | 
| ChatId | String | 本轮对话的 ChatId,ChatId 用于唯一标识一轮对话。 一个对话组中,最多支持进行100轮对话。 每轮对话数据有效期为7天,到期后 ChatId 失效,有效期内的历史对话数据可通过 History 查询,如有长期使用需求请及时保存输入输出数据。 示例值:1248907282106990592 | 
| ResultImage | Array of String | 生成图 URL 列表,有效期7天,请及时保存。 示例值:["https://cos.ap-guangzhou.myqcloud.com/xxx?q-sign-algorithm=sha1&q-ak=xxx&q-sign-time=1731657113;1732261913&q-key-time=1731657113;1732261913&q-header-list=host&q-url-param-list=&q-signature=b9c4be16d763664d829d0bfa398f571aa0e75c0e"] | 
| ResultDetails | Array of String | 结果 detail 数组,Success 代表成功。 示例值:["Success"] | 
| History | Array of History | 本轮对话前置的历史对话数据(不含生成图)。 示例值:[{"ChatId": "1248907282106990592","Prompt": "请画一个苹果在桌子上","RevisedPrompt": "风格为摄影风格,桌子上摆放着一个红润的苹果,镜头为近景镜头","Seed": 1549130027}] | 
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 | 
4. 示例
示例1 成功查询
成功查询
输入示例
POST / HTTP/1.1
Host: hunyuan.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: QueryHunyuanImageChatJob
<公共请求参数>
{
    "JobId": "1253534368-1731657099-7276788a-a326-11ef-beeb-525400bba60c-0"
}输出示例
{
    "Response": {
        "ChatId": "1248907282106990592",
        "History": [
            {
                "ChatId": "1248907282106990592",
                "Prompt": "请画一个苹果在桌子上",
                "RevisedPrompt": "风格为摄影风格,桌子上摆放着一个红润的苹果,镜头为近景镜头",
                "Seed": 1549130027
            }
        ],
        "JobErrorCode": "",
        "JobErrorMsg": "",
        "JobStatusCode": "5",
        "JobStatusMsg": "处理完成",
        "RequestId": "54c4d31e-234b-44b8-802b-7d10fa2e77dc",
        "ResultDetails": [
            "Success"
        ],
        "ResultImage": [
            "https://cos.ap-guangzhou.myqcloud.com/***?q-sign-algorithm=sha1&q-ak=xxx&q-sign-time=1731657113;1732261913&q-key-time=1731657113;1732261913&q-header-list=host&q-url-param-list=&q-signature=b9c4be16d763664d829d0bfa398f571aa0e75c0e"
        ]
    }
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 | 
|---|---|
| FailedOperation.ImageDecodeFailed | 水印图解码失败 | 
| InvalidParameter.InvalidParameter | 参数不合法。 |