Retarget

All supported parameters for animate_retarget.

Endpoint

Parameters

Required parameters

type: This field must be set to animate_retarget.

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 file format. This parameter can only be glb or fbx, and if it is not given, the default value is glb.

bake_animation: Determines whether to bake the animation into the model upon output. The default value is true. Can only be implemented on glb model.

export_with_geometry: Determines whether to include geometry in the output. The default value is true.

animation: The preset animation. Available values are as follows:

preset:idle · preset:walk · preset:run · preset:dive · preset:climb · preset:jump · preset:slash · preset:shoot · preset:hurt · preset:fall · preset:turn · preset:quadruped:walk · preset:hexapod:walk · preset:octopod:walk · preset:serpentine:march · preset:aquatic:march

animate_in_place: A bool to determine if the model will be animated in fixed place. The default value is false.

animations: An array of preset animations. Each element should be one of the preset values listed above. Length cannot be over 5.

One of animation or animations must be set.

Returns

task_id: The identifier for the successfully submitted task.