产品概述
产品优势
应用场景
Domain name for API request: hunyuan.intl.tencentcloudapi.com.
This API is used to intelligently generate 3D content based on the HunYuan Large Model and input text descriptions/images.
This API is used to provide 3 concurrent tasks by default. Up to 3 submitted tasks can be processed simultaneously. A new task can be processed only after the previous one is completed.
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: SubmitHunyuanTo3DProJob. |
| 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. This API only supports: ap-singapore, na-siliconvalley. |
| Model | No | String | Tencent HY 3D Global model version Defaults to 3.0, with optional choices: 3.0, 3.1 When selecting version 3.1, the [LowPoly] and [Sketch] parameter is unavailable Example value:3.0 |
| Prompt | No | String | Generates 3D content, describes 3D content. Supports up to 1024 utf-8 characters. Text-To-3D. Specifies either ImageBase64/ImageUrl or Prompt is required. Prompt and ImageBase64/ImageUrl cannot coexist. |
| ImageBase64 | No | String | Enter the Base64 code of the image. Size: specifies the unilateral resolution requirement, not less than 128 and not greater than 5000. size should not exceed 8m (after encoding, it increases by about 30%, recommend actual input image size no more than 6m). Input image suggestion: 1.Simple background (solid-color background) 2.No text or blended colors 3.Single object 4.The object occupies over 50% of the frame Valid values: jpg, png, jpeg, webp. Specifies either ImageBase64/ImageUrl or Prompt is required. Prompt and ImageBase64/ImageUrl cannot coexist. |
| ImageUrl | No | String | Input image Url. Size: specifies the unilateral resolution requirement, not less than 128 and not greater than 5000. size should not exceed 8m (after encoding, it increases by about 30%, recommend actual input image size no more than 6m). Input image suggestion: 1.Simple background (solid-color background) 2.No text or blended colors 3.Single object 4.The object occupies over 50% of the frame Valid values: jpg, png, jpeg, webp. Specifies either ImageBase64/ImageUrl or Prompt is required. Prompt and ImageBase64/ImageUrl cannot coexist. |
| MultiViewImages.N | No | Array of ViewImage | Multi-Perspective model image. reference value for viewing angle:. left: Left view; right: Right view; back: Rear view; top: Top view (only supported in Model 3.1); bottom: Bottom view (only supported in Model 3.1); left_front: Left front 45 degree view (only supported in Model 3.1); right_front: Right front 45 degree view (only supported in Model 3.1); Each perspective is limited to one image. Image size limit. the value must not exceed 8 mb after encoding. Image resolution limitation: the unilateral resolution should be less than 5000 and greater than 128. Supported image format: JPG or PNG |
| EnablePBR | No | Boolean | Specifies whether PBR material generation is enabled. default false |
| FaceCount | No | Integer | Specifies the face count for 3D model generation. default value is 500000. Specifies the supported face count generation range. value range: 3000-1500000 |
| GenerateType | No | String | Generation task type. default: Normal. valid values: Normal: generates a geometric model with textures LowPoly: specifies the model generated after intelligent polygon reduction. Geometry: specifies whether to generate a Geometry model without textures (white model). when this task is selected, the EnablePBR parameter does not take effect Specifies the Sketch for the generative model, allowing input of a Sketch or line drawing. in this mode, both prompt and ImageUrl/ImageBase64 can be entered together |
| PolygonType | No | String | This parameter only takes effect when LowPoly mode is selected from GenerateType Polygon type, indicates the number of sides in the model's surface grid, defaults to triangle. valid values: triangle. specifies the triangular face quadrilateral: mix quadrangle and triangle faces to generate |
| 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. |
POST / HTTP/1.1
Host: hunyuan.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SubmitHunyuanTo3DProJob
<Common request parameters>
{
"Prompt": "A cat"
}
{
"Response": {
"JobId": "1375367755519696896",
"RequestId": "13f47dd0-1af9-4383-b401-dae18d6e99fc"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
文档反馈