1. 接口描述
接口请求域名： hunyuan.tencentcloudapi.com 。
提交混元生3D任务
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：SubmitHunyuanTo3DJob。 |
| Version | 是 | String | 公共参数，本接口取值：2023-09-01。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-guangzhou 。 |
| Prompt | 否 | String | 3D内容的描述，中文正向提示词。最多支持200个 utf-8 字符，ImageBase64、ImageUrl和 Prompt必填其一，且Prompt和ImageBase64/ImageUrl不能同时存在。 示例值：一只小猫 |
| ImageBase64 | 否 | String | 输入图 Base64 数据。 大小：单边分辨率要求不小于50，不大于5000。大小不超过8m（base64编码后会大30%左右，建议实际输入图片不超过6m） 格式：jpg，png，jpeg，webp。 ImageBase64、ImageUrl和 Prompt必填其一，且Prompt和ImageBase64/ImageUrl不能同时存在。 示例值：/9j/4QlQaHR0c...N6a2M5ZCI |
| ImageUrl | 否 | String | 输入图Url。 大小：单边分辨率要求不小于50，不大于5000。大小不超过8m（base64编码后会大30%左右，建议实际输入图片不超过6m） 格式：jpg，png，jpeg，webp。 ImageBase64/ImageUrl和 Prompt必填其一，且Prompt和ImageBase64/ImageUrl不能同时存在。 示例值：https://****/imageurl.jpg |
| Num | 否 | Integer | 生成数量。默认1，当前限制只能为1。 示例值：1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| JobId | String | 任务id（有效期24小时） 示例值：1172498703139831808 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功提交任务
成功提交图生3D任务
输入示例
POST / HTTP/1.1
Host: hunyuan.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SubmitHunyuanTo3DJob
<公共请求参数>
{
"Prompt": "",
"ImageUrl": "https://xxx.jpg"
}输出示例
{
"Response": {
"JobId": "1286221236421533696",
"RequestId": "f4aac8ca-a79d-4431-81fd-7312f79bf91d"
}
}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 | 操作失败。 |
| FailedOperation.ImageDecodeFailed | 水印图解码失败 |
| FailedOperation.ImageDownloadError | LogoUrl 或 LogoImage 有误，水印图下载失败。 |
| InvalidParameter.InvalidParameter | 参数不合法。 |
| InvalidParameterValue.InvalidImageFormat | 不支持的图片格式。 |
| InvalidParameterValue.InvalidImageResolution | 不支持的图片分辨率。 |
| InvalidParameterValue.InvalidImageSize | 图片大小超出限制。 |
| InvalidParameterValue.UrlIllegal | URL格式不合法。 |
| RequestLimitExceeded.JobNumExceed | 同时处理的任务数过多，请稍后重试。 |
| ResourceInsufficient | 资源不足。 |
| ResourceInsufficient.ChargeResourceExhaust | 计费资源已耗尽。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| ResourceUnavailable.InArrears | 账号已欠费。 |
| ResourceUnavailable.LowBalance | 余额不足。 |
| ResourceUnavailable.NotExist | 计费状态未知，请确认是否已在控制台开通服务。 |
