Tripo-Rig Check

Updated at:

Tripo Rig Check determines whether a 3D model can be rigged and returns the recommended rig type.

ImportantThis document applies only to the China (Beijing) region. Use an API key from this region.

Prerequisites

  1. Enable the service: Go to the Alibaba Cloud Model Studio console, search for "Tripo", find the Tripo model card, and click Enable Now. In the dialog box, confirm the authorization.
  2. Configure your API key: Select a region, get an API key, and then configure the API key as an environment variable.
  3. Prepare a preceding task: Create a task that outputs a 3D model, such as a Tripo-Text/Image to 3D task. After the task succeeds, pass its task_id in original_model_task_id. Alternatively, skip the preceding task and pass the public URL of a model file in model_url.

HTTP calls

The API uses asynchronous calls. The process involves two steps: create a task and then poll for the result.

Step 1: Create a task

China (Beijing): POST https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/services/aigc/video-generation/3d-generation

Replace {WorkspaceId} with your actual workspace ID.

Note

  • After the task is created, use the returned task_id to query the result. The task_id is valid for 24 hours. Do not create duplicate tasks. Instead, use polling to retrieve the result.
  • For guidance for beginners, see Call APIs with Postman or cURL.

Request parameters

Request headers

Content-Type string (Required)

The content type of the request. Must be application/json.

Authorization string (Required)

Authenticates the request with a Model Studio API key. Example: Bearer sk-xxxx.

X-DashScope-Async string (Required)

Enables asynchronous processing. HTTP requests support only asynchronous calls. Must be enable.

ImportantIf this request header is missing, the error "current user api does not support synchronous calls" is returned.

Request body

model string (Required)

The model name. Fixed value: Tripo/Tripo-RigCheck.

input object (Required)

The model input.

Properties

original_model_task_id string (Conditionally required)

The preceding task ID. Pass the task_id returned when the preceding task is created. The system automatically uses the 3D model output by the task. Specify either this parameter or model_url.

The preceding task can be any task that outputs a 3D model file (such as GLB), for example a Tripo-Text/Image to 3D task. The following conditions apply:

  • The preceding task must have succeeded.
  • The account that makes this call must be the same as the account of the preceding task. Referencing a task created by another account returns a 400 error.

model_url string (Conditionally required)

The public URL of the model file. Specify either this parameter or original_model_task_id.

Model limits:

  • Supported formats: GLB, FBX, OBJ, and STL.
  • File size: up to 150 MB.

Pass a preceding task ID

# The following URL is for the China (Beijing) region. Replace {WorkspaceId} with your actual workspace ID. URLs vary by region.
curl --location 'https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/services/aigc/video-generation/3d-generation' \
    -H 'X-DashScope-Async: enable' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "model": "Tripo/Tripo-RigCheck",
    "input": {
        "original_model_task_id": "ca51d54a-ffba-4ecc-8e42-xxxxxx"
    }
}'

Pass a model URL

# The following URL is for the China (Beijing) region. Replace {WorkspaceId} with your actual workspace ID. URLs vary by region.
curl --location 'https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/services/aigc/video-generation/3d-generation' \
    -H 'X-DashScope-Async: enable' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "model": "Tripo/Tripo-RigCheck",
    "input": {
        "model_url": "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20260507/ffaaxt/tripo-text-to-3d-result.glb"
    }
}'

Response parameters

output object

The task output information.

Properties

task_id string

The task ID. Valid for queries for 24 hours.

task_status string

The status of the task.

Enumeration values

  • PENDING
  • RUNNING
  • SUCCEEDED
  • FAILED
  • CANCELED
  • UNKNOWN: The task does not exist or its status is unknown.

request_id string

Unique request identifier for tracing and troubleshooting.

code string

Error code. Returned only for failed requests. See Error codes.

message string

Detailed error message. Returned only for failed requests. See Error codes.

Successful response

Save the task_id to query the task status and result.

{
    "output": {
        "task_status": "PENDING",
        "task_id": "0385dc79-5ff8-4d82-bcb6-xxxxxx"
    },
    "request_id": "4909100c-7b5a-9f92-bfe5-xxxxxx"
}

Error response

Task creation failed. See Error codes.

{
    "code": "InvalidApiKey",
    "message": "No API-key provided.",
    "request_id": "7438d53d-6eb8-4596-8835-xxxxxx"
}

Step 2: Query the task result

China (Beijing): GET https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/tasks/{task_id}

Note

  • Polling recommendation: We recommend using a polling mechanism: query 10 seconds after submitting the task, and then every 15 to 30 seconds.
  • Task status flow: PENDING (queued) → RUNNING (processing) → SUCCEEDED (successful) / FAILED (failed).
  • Task ID validity: The task ID is valid for 24 hours. After this period, you can no longer query the result, and the API returns the task status as UNKNOWN.
  • RPS limit: The default RPS for the query API is 20. For higher-frequency queries or event notifications, we recommend that you configure asynchronous task callbacks.
  • More operations: To query tasks in batches or cancel a task, see Manage Asynchronous Tasks.

Request parameters

Request headers

Authorization string (Required)

Authenticates the request with a Model Studio API key. Example: Bearer sk-xxxx.

Path parameters

task_id string (Required)

The ID of the task.

Query task result

Replace {task_id} with the task_id value returned by the previous API call. The task_id is valid for queries for 24 hours. Replace {WorkspaceId} with your actual workspace ID.

curl -X GET https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/tasks/{task_id} \
--header "Authorization: Bearer $DASHSCOPE_API_KEY"

Response parameters

output object

The task output information.

Properties

task_id string

The task ID. Valid for queries for 24 hours.

task_status string

The status of the task.

Enumeration values

  • PENDING
  • RUNNING
  • SUCCEEDED
  • FAILED
  • CANCELED
  • UNKNOWN: The task does not exist or its status is unknown.
State transitions during polling:
  • PENDING (queued) → RUNNING (processing) → SUCCEEDED (successful) / FAILED (failed).
  • The status of the first query is usually PENDING or RUNNING.
  • When the status changes to SUCCEEDED, the response contains the check result.
  • If the status is FAILED, check the error message and retry.
  • If the status is CANCELED, the task was canceled. To continue, submit a new task.
  • If the status is UNKNOWN, the task does not exist or its status is unknown. This can occur if the task_id does not exist or has exceeded its 24-hour validity period.

submit_time string

The time when the task was submitted. Format: YYYY-MM-DD HH:mm:ss.SSS.

scheduled_time string

The time when the task started running. Format: YYYY-MM-DD HH:mm:ss.SSS.

end_time string

The time when the task was completed. Format: YYYY-MM-DD HH:mm:ss.SSS.

results array

The list of check results. Returned only when task_status is SUCCEEDED.

Properties

riggable boolean

Indicates whether the model can be rigged.

rig_type string

The recommended rig type. You can use it as the rig_type parameter of Tripo-Auto Rigging.

This value is identified from the shape of the model and is returned regardless of whether the model can be rigged. Whether the model can be rigged is determined by riggable. If riggable is false, this value is for reference only and does not mean that the model can be rigged with this rig type.

Possible values:

  • biped: Bipedal humanoid.
  • quadruped: Four-legged animal.
  • hexapod: Six-legged creature.
  • octopod: Eight-legged creature.
  • avian: Bird or winged creature.
  • serpentine: Snake-like creature.
  • aquatic: Fish or aquatic creature.

code string

Error code. Returned only for failed requests. See Error codes.

message string

Detailed error message. Returned only for failed requests. See Error codes.

usage object

The output statistics. Returned only when the task succeeds.

Properties

3d_task_type string

The task type. Fixed to rig-check for rig check.

credits_consumed integer

The credits consumed by the task. Rig check is free, so the value is always 0.

Task succeeded

{
    "request_id": "e93255d7-edc5-938e-93ae-xxxxxx",
    "output": {
        "task_id": "3b8257a9-e3ce-47c0-942f-xxxxxx",
        "task_status": "SUCCEEDED",
        "submit_time": "2026-10-19 11:59:35.151",
        "scheduled_time": "2026-10-19 11:59:35.182",
        "end_time": "2026-10-19 11:59:38.592",
        "results": [
            {
                "rig_type": "biped",
                "riggable": false
            }
        ]
    },
    "usage": {
        "3d_task_type": "rig-check",
        "credits_consumed": 0
    }
}

Task failed

If the task fails, task_status is set to FAILED, and an error code and message are returned. See Error codes.

{
    "request_id": "e5d70b02-ebd3-98ce-9fe8-xxxxxx",
    "output": {
        "task_id": "86ecf553-d340-4e21-af6e-xxxxxx",
        "task_status": "FAILED",
        "code": "InvalidParameter",
        "message": "The parameter is invalid xxxxxx"
    }
}

Task query expired

The task_id is valid for queries for 24 hours. After this period, the following response is returned.

{
    "request_id": "a4de7c32-7057-9f82-8581-xxxxxx",
    "output": {
        "task_id": "502a00b1-19d9-4839-a82f-xxxxxx",
        "task_status": "UNKNOWN"
    }
}

FAQ

Do I need to pass parameters?

No. Rig check has no optional parameters. You can pass an empty object {} for parameters or omit it. No error is returned.

Error messages

If the model call fails and returns an error message, see Error messages for solutions.