QueryHunyuan3DTask

Last updated: 2026-10-26 17:34:28Download PDF

1. API Description

Domain name for API request: mps.intl.tencentcloudapi.com.

Query the result corresponding to a Hunyuan3D task.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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: QueryHunyuan3DTask.
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.
TaskId	No	String	Task ID.

3. Output Parameters

Parameter Name	Type	Description
Status	String	Task status Enumeration values: WAIT: Queued, waiting to execute RUN: In progress DONE: Successfully completed, ResultFile3Ds has a value FAIL: Failed, ErrorCode / ErrorMessage has a value
Progress	Integer	Progress percentage, 0-100. 0 if unknown; should be 100 when DONE; retains the last known value on FAIL
ErrorCode	String	Only available when Status=FAIL. String error code (for example, InternalError.ModelInference)
ErrorMessage	String	Only has a value when Status=FAIL, detailed copywriting
ResultFile3Ds	Array of File3D	Only has a value when Status=DONE. List of output files
TaskId	String	Task ID
TaskType	String	Task type Enumeration values: text_to_3d: Text to 3D image_to_3d: Image to 3D multiview_to_3d: Multi-view to 3D mesh_to_texture: Mesh to texture mesh_to_geometry: Mesh to geometry
Prompt	String	Input prompt
RefImage	String	Image URL input in image-to-3D scenarios
MultiViewImages	Array of ViewImage	Image information input in multi-image to 3D scenarios
CreateTime	Timestamp ISO8601	Task creation time
UpdateTime	Timestamp ISO8601	Task update time
FaceCount	Integer	The target face count for the submitted task
GenerateType	String	Generation type Enumeration values: Normal: Generate a complete 3D asset (geometry + texture) Geometry: Generate only geometry (no texture, faster output speed) Texture: Generate only texture (MeshUrl is required) Default value: Normal
QueuePosition	Integer	Task position in the queue; the smaller the value, the higher the priority.
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 The task does not exist

Input Example

POST / HTTP/1.1
Host: mps.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: QueryHunyuan3DTask
<Common request parameters>

{
    "TaskId": "4deda860-a9a0-47e3-81f1-00cadf02a44c"
}

Output Example

{
    "Response": {
        "ErrorCode": "ResourceNotFound.TaskId",
        "ErrorMessage": "task not found or expired",
        "RequestId": "cec25a1e-0875-44f0-87da-2a1ebabee48b"
    }
}

Example2 Example of a relatively complete response package

Input Example

POST / HTTP/1.1
Host: mps.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: QueryHunyuan3DTask
<Common request parameters>

{
    "TaskId": "r_75466f84b0b911f1b1b66aacb78dd458"
}

Output Example

{
    "Response": {
        "CreateTime": "2026-09-15T03:56:40Z",
        "FaceCount": 500000,
        "Progress": 100,
        "Prompt": "a cute chicken, cartoon style",
        "ResultFile3Ds": [
            {
                "PreviewImageUrl": "https://hunyuan-base-prod-1258344703.cos.ap-guangzhou.myqcloud.com/openapi/text2img/838676194d9cada36394b6ef08ee9bac.png?q-ak=************************************&q-header-list=&q-key-time=1789444785%3B1789531185&q-sign-algorithm=sha1&q-sign-time=1789444785%3B1789531185&q-signature=1559acdb874c9459b83599b5b6cae25f13f0dabd&q-url-param-list=",
                "Type": "GLB",
                "Url": "https://hunyuan-3d-1258344703.cos.ap-guangzhou.myqcloud.com/gen_tmp_test/efcec080d3e049c3911d5781518e59e7/946764dab065116e55f6204f00e43eab.glb?q-sign-algorithm=sha1&q-ak=************************************&q-sign-time=1789444780%3B1789531180&q-key-time=1789444780%3B1789531180&q-header-list=&q-url-param-list=&q-signature=cbc0494a4e5504a41d53698f2916ca8845a3e9f9"
            }
        ],
        "Status": "DONE",
        "TaskId": "r_75466f84b0b911f1b1b66aacb78dd458",
        "TaskType": "text_to_3d",
        "UpdateTime": "2026-09-15T04:00:14Z",
        "RequestId": "531aa6de-1144-4797-9b87-b8c79c998160"
    }
}

Example3 Returned RefImage

Input Example

POST / HTTP/1.1
Host: mps.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: QueryHunyuan3DTask
<Common request parameters>

{
    "TaskId": "r_e6fb6e39b0ba11f1b1b66aacb78dd458"
}

Output Example

{
    "Response": {
        "CreateTime": "2026-09-15T04:07:01Z",
        "FaceCount": 500000,
        "Progress": 0,
        "RefImage": "https://hunyuan-base-test-1258344703.cos.ap-guangzhou.myqcloud.com/public/test/eba3542f-5e19-4862-b95d-c2d28e7ef91e-latent.png",
        "Status": "RUN",
        "TaskId": "r_e6fb6e39b0ba11f1b1b66aacb78dd458",
        "TaskType": "image_to_3d",
        "UpdateTime": "2026-09-15T04:07:18Z",
        "RequestId": "7b545f16-7552-4cc9-acfc-04cdc60581e8"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.