Scenarios
This document introduces how to use API 3.0 Explorer to debug Tencent Hunyuan 3D Global relevant APIs online.
Preparations
Before using Tencent Hunyuan 3D Global service, you need to sign up for a Tencent Cloud account. If there is no account, see the Tencent Cloud registration tutorial. Operation Steps
1. Enabling Tencent Hunyuan Large Model Service
After registration and real-name authentication, log in to the Tencent Hunyuan console, read and agree to the terms of service, and click to activate the service. A key refers to SecretId and SecretKey. To reduce the risks of key leakage, starting from November 30, 2023, the feature to query SecretKey is disabled for all root accounts and sub-accounts. It only supports viewing SecretKey when creating. Please save SecretKey promptly. If you forget SecretKey, you can delete the key and then create a new one.
Note:
Subaccounts can only be used after authorization by the primary account. After logging in, the primary account can click on the user list, select Authorize behind the corresponding subaccount, and a pop-up for the associated policy will appear. Enter the authorization policy name, search, select the corresponding policy, and click Confirm.
Authorization policy: QcloudAI3DFullAccess
3. Making an API Call (Example)
Because Tencent Hunyuan 3D Global Professional Edition API is an async API, you need to call the SubmitHunyuanTo3DProJob task and QueryHunyuanTo3DProJob task APIs.
API | Description |
SubmitHunyuanTo3DProJob | After inputting a Prompt or image and the request, a JobId will be returned if the request succeeds. |
QueryHunyuanTo3DProJob | Query the result info using the JobId returned from submitting the SubmitHunyuanTo3DProJob Task. Task Status Descriptions: WAIT: Waiting RUN: Executing FAIL: Task failure DONE: Task successful When querying via the QueryHunyuanTo3DProJob API, Status (task status) will be returned. If the Status is FAIL or DONE, it indicates the task has been processed. If Status is DONE: the result file can be accessed through the returned ResultFile3Ds parameter. If Status is FAIL: the error cause can be obtained through the returned ErrorCode and ErrorMessage parameters. If Status is WAIT or RUN: it indicates no result info is retrieved and you need to continue retrieving. |
Calling API through API Explorer Online
Call the API for SubmitHunyuanTo3DProJob task: After parameters are entered, click to initiate call, and the result message of the SubmitHunyuanTo3DProJob task will be returned.
A JobId and RequestId will be returned if the request succeeds.
Request failure returns Code and Message.
QueryHunyuanTo3DProJobTask API: Obtain the result info using the JobId returned from a successful SubmitHunyuanTo3DProJob Task.
Task Status Descriptions:
WAIT: Waiting
RUN: Executing
FAIL: Task failure
DONE: Task successful
When submitting a query, Status (task status) will be returned. If the Status is DONE or FAIL, it indicates the task has been processed.
If Status is DONE: the result info can be accessed through the returned ResultFile3Ds parameter.
If Status is FAIL: the error cause can be obtained through the returned ErrorCode and ErrorMessage parameters.
If Status is WAIT or RUN: it indicates no result info is retrieved and you need to continue retrieving.