操作场景
本文将为您介绍如何使用 API 3.0 Explorer 在线调试腾讯混元生图相关接口。
准备工作
操作步骤
1. 开通腾讯混元生图服务
2. 获取密钥信息
密钥是指：SecretId 和 SecretKey ，为降低密钥泄漏的风险，自2023年11月30日起，对所有主账号、子账号的密钥，关闭查询 SecretKey 的功能，仅支持在创建时查看，请及时保存 SecretKey 。如果忘记 SecretKey ，可以删除密钥之后重新创建一个。
说明：
子账户调用需要主账户授权才可以使用，主账户登录之后点击用户列表，在对应的子账户后面选择授权，会弹出关联策略的弹窗，输入授权策略名称之后搜索，选择对应的策略点击确认。
授权策略：
QcloudAI3DFullAccess
3. 调用api接口（示例）
腾讯混元生图分两种类型的接口。分别是同步接口和异步接口。
同步接口示例如下表：
接口名称 | 能力描述 |
图像风格化（图生图） | 根据输入的图像及文本描述，智能生成风格转化后的图像 |
异步接口示例如下表：
产品名称 | 接口名称 | 说明 |
AI写真 | 上传写真训练图片 | AI 写真分为上传训练图片、训练写真模型（可选跳过）、生成写真图片3个环节，需要依次调用对应接口。 本接口用于上传单人像图片并指定对应的写真模型 ID。 可选模式如下： ● 常规训练模式：上传20 - 25张图片用于模型训练，完成训练后可生成写真图片。 调用接口顺序：上传写真训练图片——提交训练写真模型任务——查询训练写真模型任务——提交生成写真图片任务——查询生成写真图片任务。 ● 快速训练模式：仅需上传1张图片用于模型训练，训练速度更快，完成训练后可生成写真图片。 调用接口顺序：上传写真训练图片——提交训练写真模型任务——查询训练写真模型任务——提交生成写真图片任务——查询生成写真图片任务。 ● 免训练模式：仅需上传1张图片，跳过训练环节，直接生成写真图片。 调用顺序：上传写真训练图片——提交生成写真图片任务——查询生成写真图片任务。 |
| 提交训练写真模型任务 | |
| 查询训练写真模型任务 | |
| 提交生成写真图片任务 | |
| 查询生成写真图片任务 | |
方式一：通过 API Explorer 在线调用接口
异步接口调用参考（以AI写真为例）：
说明：
第一步：先调用上传写真训练图片 接口，输入 ModelId 、BaseUrl 、TrainMode 点击发起调用。
ModelId：自定义参数，由英文大小写字母、数字及下划线组成，用于唯一标识一个写真模型，一个写真模型只能用于一个人物的写真图片生成。
BaseUrl：写真模型训练用的基础图像 URL，用于固定写真模型可生成的人物。
TrainMode：训练模式。
默认使用常规训练模式。如果使用快速训练模式和免训练模式，只需要在 BaseUrl 中传入1张图片，Urls.N 中无需传入图片。
0：常规训练模式，上传多张图片用于模型训练，完成训练后可生成写真图片。
1：快速训练模式，仅需上传1张图片用于模型训练，训练速度更快，完成训练后可生成写真图片。
2：免训练模式，仅需上传1张图片，跳过模型训练环节，直接生成写真图片。
成功结果参考：会返回一个 RequestId 。
失败结果参考：返回报错的 Code 和 message 。
第二步：因为示例输入的训练模式是免训练模式，所以可直接提交生成写真图片任务接口，提交成功之后会返回 JobId 和 RequestId 。
第三步：点击查询生成写真图片任务，使用提交生成写真图片任务接口返回 JobId 去获取结果信息。
任务状态说明：
INIT：初始化中。
WAIT：等待中。
RUN：运行中。
FAIL：处理失败。
DONE：处理完成。
提交查询的时候会返回 JobStatusCode（任务状态），当 JobStatusCode 为 FAIL、DONE 的时候，表示任务已经处理完成。
如果 JobStatusCode 为 DONE：判断 ResultDetails 参数返回的状态是否为 SUCCESS。
如果为 SUCCESS，可通过返回的 ResultUrls 参数获取到结果视频。
如果不为SUCCESS，则 ResultDetails 会返回具体的错误码信息。
如果 JobStatusCode 为 FAIL：可以通过返回的 JobErrorCode 参数跟 JobErrorMsg 参数获取报错原因。
如果 JobStatusCode 为 INIT、WAIT、RUN：则表示没有拉取到结果信息，需要继续拉取。
同步接口调用参考（以图像风格化为例）：
说明：
成功结果参考：会返回 RequestId 和 ResultImage ，通过 ResultImage 获取结果图片。
失败结果参考：返回报错的 code 和 message 。
方式二：安装 SDK 调用接口
点击代码示例，可以查询到目前可以安装 SDK 的开发语言，选择安装对应版本的 SDK 进行调用，如下图：
