1. API Description
Domain name for API request: hunyuan.intl.tencentcloudapi.com.
This API is used to intelligently generate 3D content based on the HunYuan Large Model with input text descriptions or images.
This API is used to provide 1 concurrent task by default, which means only 1 submitted task can be processed simultaneously. The next task can be processed only after the previous task is completed.
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: SubmitHunyuanTo3DRapidJob. |
| Version | Yes | String | Common Params. The value used for this API: 2023-09-01. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Prompt | No | String | Text-To-3D, description of 3D content, forward Prompt content Supports up to 200 utf-8 characters Either ImageBase64, ImageUrl, or Prompt is required, and Prompt cannot coexist with ImageBase64/ImageUrl |
| ImageBase64 | No | String | Input image Base64 data Size: unilateral resolution requirement not less than 128, not greater than 5000, size not greater than 6mb (after encoding, size increases by approximately 30%). format: jpg, png, jpeg, webp Imagebase64, imageurl, and Prompt are required, but Prompt and imagebase64/imageurl cannot coexist |
| ImageUrl | No | String | Input image Url size: Unilateral resolution requirement not less than 128, not greater than 5000. size not greater than 8mb Format: jpg, png, jpeg, webp Imagebase64, imageurl, and Prompt are required, and Prompt cannot coexist with imagebase64/imageurl |
| ResultFormat | No | String | Returns the 3D file format. valid values: OBJ, GLB, STL, USDZ, FBX, MP4, GIF Recommended input models below 50W, may timeout when selecting USDZ, MP4, or GIF format Example value: STL |
| EnablePBR | No | Boolean | Specifies whether PBR material generation is enabled, false by default. |
| EnableGeometry | No | Boolean | Specifies whether to enable the single geometry generation option When enabled, it generates a 3D model without textures (white model) When enabled, the generative model does not support OBJ format Default model file format is GLB |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| JobId | String | Task ID (valid period: 24 hours) |
| 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 Submitting a Task Call Example
Input Example
POST / HTTP/1.1
Host: hunyuan.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SubmitHunyuanTo3DRapidJob
<Common request parameters>
{
"ImageUrl": "https://***.cos.ap-guangzhou.myqcloud.com/***.jpg"
}Output Example
{
"Response": {
"JobId": "1335141824121323520",
"RequestId": "5f84f1df-7a29-4f93-8dc0-d9e6dea6bff9"
}
}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.
Feedback