http
Base URL: https://openapi.tripo3d.ai/v3
Endpoint: POST /animations/retarget
Apply a preset animation to a rigged 3D model.
Note
- This endpoint requires an API Key. Include it in the Authorization header as Bearer {api_key}.
- This is an asynchronous API. After submitting the request, use the Task Query API to poll for results, or configure a Webhook to receive automatic notifications when the task completes.
Request Parameters
Request Body
inputstringRequired
task_id of the rigged model, starting with
task_.animationstringConditional
Single preset animation identifier.
Mutually exclusive with
animations — provide only one.Notes
Rig v2.5-20260210 — All rig types
- Biped:
preset:idle,preset:walk,preset:run,preset:dive,preset:climb,preset:jump,preset:slash,preset:shoot,preset:hurt,preset:fall,preset:turn - Quadruped:
preset:quadruped:walk - Others:
preset:hexapod:walk,preset:octopod:walk,preset:serpentine:march,preset:aquatic:march
Rig v1.0-20240301 — Biped only (90+ presets, click to expand)
preset:biped:afraidpreset:biped:agreepreset:biped:angry_01preset:biped:angry_02preset:biped:angry_03preset:biped:basketball_shotpreset:biped:bowpreset:biped:box_01preset:biped:box_02preset:biped:box_03preset:biped:cast_a_spellpreset:biped:cheerpreset:biped:choppreset:biped:clappreset:biped:climbpreset:biped:complain_01preset:biped:complain_02preset:biped:cross_body_crunchpreset:biped:crossover_dribblepreset:biped:crypreset:biped:dance_01preset:biped:dance_02preset:biped:dance_03preset:biped:dance_04preset:biped:dance_05preset:biped:dance_06preset:biped:defeat_02preset:biped:defeat_03preset:biped:depressedpreset:biped:digpreset:biped:divepreset:biped:dribblepreset:biped:fallpreset:biped:firepreset:biped:flee_01preset:biped:flee_02preset:biped:flippreset:biped:fold_armspreset:biped:football_catchpreset:biped:football_savepreset:biped:football_passpreset:biped:freakypreset:biped:frightenedpreset:biped:front_kick_01preset:biped:front_kick_02preset:biped:frustrated_01preset:biped:frustrated_02preset:biped:golfpreset:biped:greet_01preset:biped:greet_02preset:biped:greet_03preset:biped:greet_04preset:biped:heart_posepreset:biped:hit_to_body_01preset:biped:hit_to_body_02preset:biped:hit_to_headpreset:biped:hit_to_sidepreset:biped:hit_to_stomachpreset:biped:hugpreset:biped:hurtpreset:biped:idlepreset:biped:jump_downpreset:biped:jumppreset:biped:jump_rope_01preset:biped:jump_rope_02preset:biped:laugh_01preset:biped:laugh_02preset:biped:lift_heavypreset:biped:look_aroundpreset:biped:make_a_call_01preset:biped:make_a_call_02preset:biped:pitch_baseballpreset:biped:play_mobile_gamepreset:biped:play_video_gamepreset:biped:press-uppreset:biped:run_upstairspreset:biped:runpreset:biped:scared_01preset:biped:scared_02preset:biped:scratchpreset:biped:shootpreset:biped:shovelpreset:biped:sing_01preset:biped:sing_02preset:biped:sing_03preset:biped:sing_04preset:biped:sitpreset:biped:slashpreset:biped:sobpreset:biped:standing_relaxpreset:biped:surfpreset:biped:swaggerpreset:biped:swimpreset:biped:turnpreset:biped:victory_celebrationpreset:biped:volleyballpreset:biped:waitpreset:biped:walkpreset:biped:warm_uppreset:biped:wave_goodbye_01preset:biped:wave_goodbye_02animationsstring[]Conditional
List of multiple preset animation identifiers.
Mutually exclusive with
animation — provide only one.out_formatstringdefault: glb
Output format.
glb— binary glTF, web-ready.fbx— FBX for DCC tools and game engines.
bake_animationbooleandefault: true
Bake animation into the model. Only effective for
glb output.export_with_geometrybooleandefault: true
Export with geometry included.
animate_in_placebooleandefault: false
Play animation in place without displacement.
Examples
Single
{
"input": "task_abc123",
"animation": "preset:walk",
"out_format": "glb",
"bake_animation": true
}Batch
{
"input": "task_abc123",
"animations": [
"preset:idle",
"preset:walk",
"preset:run"],
"out_format": "fbx"}Create task
{
"code": 0,
"data": {
"task_id": "task_abc123"}
}Task result
{
"code": 0,
"data": {
"task_id": "task_def456",
"status": "success",
"output": {
"model_url": "https://cdn.tripo3d.ai/output/animated.glb"},
"credits_consumed": 20
}
}