Retarget
All supported parameters for animate_retarget.
Endpoint
Parameters
Required parameters
type: This field must be set to animate_retarget.
original_model_task_id: task_id of the upstream animate_rig task.
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.
| Task | Type | Description |
|---|---|---|
| Mesh Segmentation | mesh_segmentation | Splits the model into editable parts |
| Mesh Completion | mesh_completion | Applies segmentation results and completes selected parts |
| Smart LowPoly | highpoly_to_lowpoly | Remeshes the model to a lower polygon count, including quad output (quad=true) |
| Format Conversion (remesh) | convert_model | Remeshing 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.
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 animations. Available values depend on the rig model version used in the upstream animate_rig task.
- Rig v2.5 (
v2.5-20260210): fixed whitelist, 27 presets. For the biped locomotion and combat names below, bothpreset:<name>andpreset:biped:<name>are supported:idle,walk,run,dive,climb,jump,slash,shoot,hurt,fall,turn.preset:idle/preset:biped:idlepreset:walk/preset:biped:walkpreset:run/preset:biped:runpreset:dive/preset:biped:divepreset:climb/preset:biped:climbpreset:jump/preset:biped:jumppreset:slash/preset:biped:slashpreset:shoot/preset:biped:shootpreset:hurt/preset:biped:hurtpreset:fall/preset:biped:fallpreset:turn/preset:biped:turnpreset:quadruped:walkpreset:hexapod:walkpreset:octopod:walkpreset:serpentine:marchpreset:aquatic:march
- Rig v1.0 (
v1.0-20240301): biped only (101 names, 202 identifiers). Each<name>below supports bothpreset:<name>andpreset:biped:<name>(for examplepreset:walkandpreset:biped:walk).
Biped — expand for the full motion list
- afraid
- agree
- angry_01
- angry_02
- angry_03
- basketball_shot
- bow
- box_01
- box_02
- box_03
- cast_a_spell
- cheer
- chop
- clap
- climb
- complain_01
- complain_02
- cpr
- cross_body_crunch
- crossover_dribble
- cry
- dance_01
- dance_02
- dance_03
- dance_04
- dance_05
- dance_06
- defeat_02
- defeat_03
- depressed
- dig
- dive
- dribble
- fall
- fire
- flee_01
- flee_02
- flip
- fold_arms
- football_catch
- football_pass
- football_save
- freaky
- frightened
- front_kick_01
- front_kick_02
- frustrated_01
- frustrated_02
- golf
- greet_01
- greet_02
- greet_03
- greet_04
- heart_pose
- hit_to_body_01
- hit_to_body_02
- hit_to_head
- hit_to_side
- hit_to_stomach
- hug
- hurt
- idle
- jump
- jump_down
- jump_rope_01
- jump_rope_02
- laugh_01
- laugh_02
- lift_heavy
- look_around
- make_a_call_01
- make_a_call_02
- pitch_baseball
- play_mobile_game
- play_video_game
- run
- run_upstairs
- scared_01
- scared_02
- scratch
- shoot
- shovel
- sing_01
- sing_02
- sing_03
- sing_04
- sit
- slash
- sob
- standing_relax
- surf
- swagger
- swim
- turn
- victory_celebration
- volleyball
- wait
- walk
- warm_up
- wave_goodbye_01
- wave_goodbye_02
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 must be a preset allowed for the upstream rig version. Length cannot be over 5.
One of
animationoranimationsmust be set.
Returns
task_id: The identifier for the successfully submitted task.