tencent cloud

APIs

DocumentationAPIsTencent HY Hunyuan 3D APIsSubmitAutoRiggingJob

SubmitAutoRiggingJob

Focus Mode
Font Size
Last updated: 2026-05-08 20:21:46

1. API Description

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

3D Model Auto Rigging API, powered by the HY Large Model, processes input 3D models of characters or animals to perform automatic rigging and skinning, outputting a 3D model complete with skeletal data. By default, one concurrent slot is provided, meaning that a maximum of one submitted task can be processed simultaneously; the next task can only begin processing once the previous one has been completed.

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: SubmitAutoRiggingJob.
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.
File3D Yes InputFile3D

3D Character Model File: Generates a 3D character animation based on the provided source model.
The character model must be in a standard T-Pose (a standing posture with both arms extended horizontally). You must select exactly one of the following 3D model file options; reference specifications:
fbx: 3D model file in FBX format; file size must not exceed 60 MB.
obj: 3D model file in OBJ format; file size must not exceed 60 MB.
MotionType No Integer

Preset Action Types (Reference Values):

  1. Roundhouse Kick
  2. Left Hook
  3. Charged Attack
  4. Charged Punch
  5. Two-Hit Combo
  6. Two-Hit Combo - 2
  7. Backstep
  8. Hit Reaction
  9. Hit Reaction - 2
  10. Hit Reaction - 3
  11. Knockdown - 1
  12. Knockdown - 2
  13. Landing
  14. Dejection
  15. Throat Slash
  16. Jab
  17. Continuous Strikes
  18. Kick
  19. Side Kick
  20. Tai Chi
  21. Backflip
  22. Crouching Turn
  23. Walk - 1
  24. Walk - 2
  25. Walk - 3
  26. Idle - 1
  27. Idle - 2
  28. Street Dance
  29. The Twist
  30. Turn Left
  31. Turn Right
  32. Jog
  33. Jog - 2
  34. Run
  35. Sprint - 1
  36. Sprint - 2
  37. Sprint - 3
  38. Jump (In Place) - 1
  39. Sliding Tackle
  40. Long Jump (Forward)
  41. Long Jump (Forward) - 2
  42. Vault
  43. Intimidation
  44. Fall Forward
  45. Turn Right
  46. Jump (In Place) - 2
  47. Turn Around
  48. Send Shockwave

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 Calling the API

Input Example

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

{
    "File3D": {
        "Url": "https://********************cos.ap-singapore.myqcloud.com/217f6940-bd92-4b15-9bd5-924ae622b1b7_0.fbx",
        "Type": "FBX"
    },
    "MotionType": 1
}

Output Example

{
    "Response": {
        "JobId": "1440373416789442560",
        "RequestId": "9635e235-a5b9-4b03-8409-81f8e2921806"
    }
}

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

6. Error Code

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

Previous Topic: SubmitHunyuanTo3DTextureEditJobNext Topic: QueryHunyuanTo3DTextureEditJob

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback