Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to create AIGC Hunyuan 3D tasks.
A maximum of 20 requests can be initiated per second for this API.
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: CreateAigcHunyuan3DTask. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| SubAppId | No | Integer | On-demand application ID. For customers who activate on-demand services from December 25, 2023, if they access resources in on-demand applications (whether the default application or a newly created application), this field must be filled with the app ID. |
| ImageInfos.N | No | Array of AigcHunyuan3DReferenceImageInfo | Generate reference image information for the 3D model. Input parameter limit: The maximum array length is 1. The three input parameters ImageInfos, MultiViewImageInfos, and Prompt are mutually exclusive. One and only one must be filled in. |
| MultiViewImageInfos.N | No | Array of AigcHunyuan3DMultiViewImageInfo | Multi-perspective image information used to generate 3D models. Input limitations: The array length must be between 2 and 8, and it must contain the front perspective. The three input parameters ImageInfos, MultiViewImageInfos, and Prompt are mutually exclusive with each other. One and only one must be filled in. |
| Prompt | No | String | Prompt content for generating a 3D model. Input parameter limit: up to 1024 utf-8 characters. The three input parameters ImageInfos, MultiViewImageInfos, and Prompt are mutually exclusive. One and only one must be filled in. |
| GenerateType | No | String | Generation Type. Enumeration values:
Default value: Normal |
| MeshInfos.N | No | Array of AigcHunyuan3DMeshInfo | Reference 3D model used to generate a 3D model. Input parameter limit: when MeshInfos is filled in, GenerateType must be set to Texture (texture scenario). |
| EnablePBR | No | String | Whether to enable output of PBR materials. Enumeration values:
Default value: Disabled |
| FaceCount | No | Integer | Number of patches. This parameter is valid only when GenerateType is Normal or Geometry. Value range: [3000, 1500000] Default value: 500000 |
| KeepUV | No | String | Whether to reserve UV unfolding. Enumeration values:
Default value: Disabled |
| ResultFormat | No | String | Result format. In addition to the default return of obj and glb, an extra output format. Enumeration values:
|
| Seed | No | Integer | Random Seed. Results are reproducible with the same Seed input. Value range: [0, 2147483647] |
| Style | No | String | Style control word. |
| OutputConfig | No | AigcHunyuan3DOutputConfig | Output media file configuration of the task. |
| SessionId | No | String | Identifier for deduplication. If a request with the same identifier has been sent within the past three days, an error is returned for the current request. The maximum length is 50 characters. If this is not specified or left empty, deduplication is not performed. |
| SessionContext | No | String | Source context. This is used to pass through user request information. The audio and video quality revival complete callback returns the value of this field. The maximum length is 1000 characters. |
| TasksPriority | No | Integer | Task priority. The higher the value, the higher the priority. The value range is from -10 to 10. If left blank, the default value is 0. |
| 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. |
Generate 3D content with prompt content
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAigcHunyuan3DTask
<Common request parameters>
{
"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"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.InvalidVodUser | VOD service is not enabled. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue | Parameter value error. |
| InvalidParameterValue.FileId | FileId does not exist. |
| InvalidParameterValue.SessionContextTooLong | SessionContext is too long. |
| InvalidParameterValue.SessionIdTooLong | SessionId is too long. |
| InvalidParameterValue.SubAppId | Parameter value error: app ID. |
| LimitExceeded.Quota | The quota limit is exceeded. |
| UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback