SubmitHunyuan3DTask
1. API Description
Domain name for API request: mps.intl.tencentcloudapi.com.
Submit creation of a Hunyuan 3D task.
A maximum of 20 requests can be initiated per second for this API.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: SubmitHunyuan3DTask. |
| Version | Yes | String | Common Params. The value used for this API: 2019-06-12. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| Prompt | No | String | Prompt for text-to-3D Input limit: up to 1024 utf-8 characters |
| ImageUrl | No | String | Image URL (http/https) for image-to-3D |
| MultiViewImages.N | No | Array of ViewImage | Generate 3D from multi-perspective images. At least 2 images are required, and a front view must be included. |
| GenerateType | No | String | Generation Type Enumeration values:
Default value: Normal |
| MeshUrl | No | String | URL of the existing 3D model (only .glb / .obj supported). If MeshUrl is passed, GenerateType=Texture is mandatory (texture scenario) |
| EnablePBR | No | Boolean | Whether to output the PBR material Default value: false |
| FaceCount | No | Integer | Patch count in the range of [3000, 1500000]. This parameter takes effect only for the Normal/Geometry branch. Parameter value range: [3000, 1500000] Default value: 500000 |
| KeepUV | No | Boolean | Reserve UV unfolding or not Default value: false |
| ResultFormat | No | String | A format attached to the output in addition to the default obj + glb. Currently only support FBX |
| Seed | No | Integer | Random Seed. The result can be reproduced with identical Seed input. |
| Style | No | String | Style control words |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TaskId | String | Task ID. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Multi-Perspective Image-to-3D
Input Example
POST / HTTP/1.1
Host: mps.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SubmitHunyuan3DTask
<Common request parameters>
{
"MultiViewImages": [
{
"ViewType": "front",
"ViewImageUrl": "https://hunyuan-base-test-1258344703.cos.ap-guangzhou.myqcloud.com/public/test/eba3542f-5e19-4862-b95d-c2d28e7ef91e-latent.png"
}
],
"EnablePBR": true
}Output Example
{
"Response": {
"TaskId": "r_fbdac9ac98c311f18af6166e9d240373",
"RequestId": "1a15321e-f92f-404e-8ccc-8b33d5359f14"
}
}5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.