Rig (v2.0-20250506)

All supported parameters for animate_rig when model_version is v2.0-20250506.

Skeletal binding and animation

The following tasks rebuild or modify mesh geometry. The output model does not retain skeletal binding or animation data from the input:

• Remesh
  • Format conversion (convert_model) with quad enabled, or when face_limit triggers retopology
  • Smart low poly (highpoly_to_lowpoly, including when quad is enabled)
• Mesh segmentation (mesh_segmentation)
• Mesh completion (mesh_completion): merges edited segmentation parts back into a complete model

If the model is already rigged or retargeted, complete all mesh editing first, then run rigging and retargeting. Alternatively, re-run rigging and retargeting after the tasks above.

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.0-20250506.

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

spec: The text value which specifies the rigging method to be used. Available options are mixamo and tripo. The default value is tripo.

Returns

task_id: The identifier for the successfully submitted task.