1. 接口描述
接口请求域名: vod.tencentcloudapi.com 。
该接口用于创建 AIGC 混元 3D 任务。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateAigcHunyuan3DTask。 |
| Version | 是 | String | 公共参数,本接口取值:2018-07-17。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| SubAppId | 否 | Integer | 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。 示例值:250000002 |
| ImageInfos.N | 否 | Array of AigcHunyuan3DReferenceImageInfo | 生成 3D 模型的参考图片信息。 入参限制:数组长度最大为1。 ImageInfos、MultiViewImageInfos、Prompt 三个入参各自互斥,有且只能填写一个。 |
| MultiViewImageInfos.N | 否 | Array of AigcHunyuan3DMultiViewImageInfo | 用于生成 3D 模型的多视角图片信息。 入参限制:数组长度必须在2-8之间,且必须包含 front 视角。 ImageInfos、MultiViewImageInfos、Prompt 三个入参各自互斥,有且只能填写一个。 |
| Prompt | 否 | String | 生成 3D 模型的提示词。 入参限制:最长 1024 个 utf-8 字符。 ImageInfos、MultiViewImageInfos、Prompt 三个入参各自互斥,有且只能填写一个。 示例值:a mechanical dragon |
| GenerateType | 否 | String | 生成类型。 枚举值:
默认值:Normal 示例值:Normal |
| MeshInfos.N | 否 | Array of AigcHunyuan3DMeshInfo | 用于生成 3D 模型的参考 3D 模型。 入参限制:当填写 MeshInfos 时,则 GenerateType 取值必须为 Texture(贴纹理场景)。 |
| EnablePBR | 否 | String | 是否开启输出 PBR 材质。 枚举值:
默认值:Disabled 示例值:Enabled |
| FaceCount | 否 | Integer | 面片数。仅 GenerateType 取值为 Normal 和 Geometry 时生效。 取值范围:[3000, 1500000] 默认值:500000 示例值:100000 |
| KeepUV | 否 | String | 是否保留 UV 展开。 枚举值:
默认值:Disabled 示例值:Enabled |
| ResultFormat | 否 | String | 结果格式。除默认返回的 obj 和 glb 外,附加输出的一种格式。 枚举值:
示例值:FBX |
| Seed | 否 | Integer | 随机种子,同一 Seed 输入下结果可复现。 取值范围:[0, 2147483647] 示例值:20260815 |
| Style | 否 | String | 风格控制词。 示例值:cyberpunk |
| OutputConfig | 否 | AigcHunyuan3DOutputConfig | 任务的输出媒体文件配置。 |
| SessionId | 否 | String | 用于去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。 示例值:my***Id |
| SessionContext | 否 | String | 来源上下文,用于透传用户请求信息,音画质重生完成回调将返回该字段值,最长 1000 个字符。 示例值:*Context |
| TasksPriority | 否 | Integer | 任务的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。 示例值:1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 任务 ID。 示例值:251**-AigcHunyuan3DTask-7bf97*afcdb0f0342fc2t |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 文生 3D
通过提示词生成 3D
输入示例
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAigcHunyuan3DTask
<公共请求参数>
{
"SubAppId": 250000002,
"Prompt": "a warrior holding a sword",
"KeepUV": "Enabled",
"Style": "cyberpunk",
"OutputConfig": {
"StorageMode": "Temporary"
},
"SessionId": "my*******Id",
"SessionContext": "*********Context",
"TasksPriority": 1
}
输出示例
{
"Response": {
"TaskId": "251******-AigcHunyuan3DTask-7bf97*************afcdb0f0342fc2t",
"RequestId": "a92d6730-19ec-4c3f-b579-44097aab0fc2"
}
}
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 | 操作失败。 |
| FailedOperation.InvalidVodUser | 没有开通点播业务。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.FileId | FileId 不存在。 |
| InvalidParameterValue.SessionContextTooLong | SessionContext 过长。 |
| InvalidParameterValue.SessionIdTooLong | SessionId 过长。 |
| InvalidParameterValue.SubAppId | 参数值错误:应用 ID。 |
| LimitExceeded.Quota | 超出配额限制 |
| UnauthorizedOperation | 未授权操作。 |