Skip to content

Rig (v2.5-20260210) ​

All supported parameters for animate_rig when model_version is v2.5-20260210.

WARNING

v2.0-20250506 is offline. Do not send it. Use v2.5-20260210.

Rig data

Mesh editing and remeshing reconstruct model geometry and do not preserve skeletal (rig) data — including bones, skin weights, and animation bindings — even when the input model was previously rigged or retargeted.

TaskTypeDescription
Mesh Segmentationmesh_segmentationSplits the model into editable parts
Mesh Completionmesh_completionApplies segmentation results and completes selected parts
Smart LowPolyhighpoly_to_lowpolyRemeshes the model to a lower polygon count, including quad output (quad=true)
Format Conversion (remesh)convert_modelRemeshing via quad=true; skeleton data is not preserved regardless of the with_animation setting

Complete all mesh editing and remeshing steps before running animate_prerigcheck → animate_rig → animate_retarget. If you process a rigged model with any of the tasks above, re-run the full animation pipeline on the resulting static mesh.

Endpoint ​

Parameters ​

Required parameters ​

type: This field must be set to animate_rig.

original_model_task_id: The task_id of previous model, the model_version of previous task should be in (Turbo-v1.0-20250506 or over v2.0-20240919). Only the task IDs of the tasks which has model output can be used.

Note

1.x versions of text_to_model, image_to_model and multiview_to_model tasks are not supported.

Optional parameters ​

out_format: The text value of the file format. This parameter can only be glb or fbx, and if it is not given, the default value is glb.

model_version: Set to v2.5-20260210.

rig_type: The text value specifies the skeletal rig type to be applied to the model. The default value is biped.

spec: Specifies the rigging method to be used. Available options are mixamo and tripo. The default value is tripo. Only tripo is supported for retarget.

Returns ​

task_id: The identifier for the successfully submitted task.