fal Assets is now live!
Docs
Log-inSign-up

fal-ai/meshy/rigging/multi-animation

Meshy auto-rigs a humanoid 3D model fitting a skeleton and binding the mesh, then applies several motion presets from its animation library
Inference
Commercial use
Partner
Schema
LLMs
PlaygroundAPIExamples

Table of contents

About

Auto-rig a 3D humanoid model and generate multiple animation clips.

Like /rigging, but dedicated to producing several animation clips from a single rig in one request. Each preset ID in animation_action_ids becomes an independent Meshy animation task (run concurrently against the shared rig) and is returned as a separate entry in the animations output array, in request order.

Accepts any publicly accessible GLB URL — works with models generated by Hunyuan, Trellis, Meshy, or any other 3D generation tool.

Features:

  • Automatic humanoid rigging with skeleton
  • Multiple animation presets applied to one rig in a single call
  • Output in both GLB and FBX formats per clip

1. Calling the API#

Install the client#

The client provides a convenient way to interact with the model API.

npm install --save @fal-ai/client

Setup your API Key#

Set FAL_KEY as an environment variable in your runtime.

export FAL_KEY="YOUR_API_KEY"

Submit a request#

The client API handles the API submit protocol. It will handle the request status updates and return the result when the request is completed.

import { fal } from "@fal-ai/client";

const result = await fal.subscribe("fal-ai/meshy/rigging/multi-animation", {
  input: {
    model_url: "https://storage.googleapis.com/falserverless/model_tests/video_models/base_basic_shaded.glb",
    animation_action_ids: [36, 92]
  },
  logs: true,
  onQueueUpdate: (update) => {
    if (update.status === "IN_PROGRESS") {
      update.logs.map((log) => log.message).forEach(console.log);
    }
  },
});
console.log(result.data);
console.log(result.requestId);

2. Authentication#

The API uses an API Key for authentication. It is recommended you set the FAL_KEY environment variable in your runtime when possible.

API Key#

In case your app is running in an environment where you cannot set environment variables, you can set the API Key manually as a client configuration.
import { fal } from "@fal-ai/client";

fal.config({
  credentials: "YOUR_FAL_KEY"
});

3. Queue#

Submit a request#

The client API provides a convenient way to submit requests to the model.

import { fal } from "@fal-ai/client";

const { request_id } = await fal.queue.submit("fal-ai/meshy/rigging/multi-animation", {
  input: {
    model_url: "https://storage.googleapis.com/falserverless/model_tests/video_models/base_basic_shaded.glb",
    animation_action_ids: [36, 92]
  },
  webhookUrl: "https://optional.webhook.url/for/results",
});

Fetch request status#

You can fetch the status of a request to check if it is completed or still in progress.

import { fal } from "@fal-ai/client";

const status = await fal.queue.status("fal-ai/meshy/rigging/multi-animation", {
  requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b",
  logs: true,
});

Get the result#

Once the request is completed, you can fetch the result. See the Output Schema for the expected result format.

import { fal } from "@fal-ai/client";

const result = await fal.queue.result("fal-ai/meshy/rigging/multi-animation", {
  requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});
console.log(result.data);
console.log(result.requestId);

4. Files#

Some attributes in the API accept file URLs as input. Whenever that's the case you can pass your own URL or a Base64 data URI.

Data URI (base64)#

You can pass a Base64 data URI as a file input. The API will handle the file decoding for you. Keep in mind that for large files, this alternative although convenient can impact the request performance.

Hosted files (URL)#

You can also pass your own URLs as long as they are publicly accessible. Be aware that some hosts might block cross-site requests, rate-limit, or consider the request as a bot.

Uploading files#

We provide a convenient file storage that allows you to upload files and use them in your requests. You can upload files using the client API and use the returned URL in your requests.

import { fal } from "@fal-ai/client";

const file = new File(["Hello, World!"], "hello.txt", { type: "text/plain" });
const url = await fal.storage.upload(file);

Read more about file handling in our file upload guide.

5. Schema#

Input#

model_url string* required

URL of a 3D model in GLB format to rig and animate. Can be any publicly accessible URL — works with models generated by Hunyuan, Trellis, Meshy, or any other 3D generation tool. The model must be a humanoid character with clearly defined limbs.

height_meters float

Approximate height of the character in meters. Default value: 1.7

animation_action_ids list<integer>* required

Animation preset IDs from Meshy's library. One animation clip is generated per ID against the same rig and returned in the 'animations' output array, in request order. Must contain at least one ID. Each ID must be in [0, 696], at most 10 distinct clips may be requested, and duplicate IDs are de-duplicated. See https://docs.meshy.ai/en/api/animation-library for available IDs.

enable_safety_checker boolean

If set to true, input data will be checked for safety before processing. Default value: true

{
  "model_url": "https://storage.googleapis.com/falserverless/model_tests/video_models/base_basic_shaded.glb",
  "height_meters": 1.7,
  "animation_action_ids": [
    36,
    92
  ],
  "enable_safety_checker": true
}

Output#

rigged_character_glb File

Rigged character in GLB format.

rigged_character_fbx File

Rigged character in FBX format.

basic_animations BasicAnimations

Basic walking and running animations included with rigging.

animations list<AnimationClip>

Animation clips generated against the rig — one entry per requested animation action ID, in request order.

rig_task_id string

Meshy rigging task ID.

{
  "animations": [
    {}
  ]
}

Other types#

ModelUrls#

glb File

GLB format 3D model

fbx File

FBX format 3D model

obj File

OBJ format 3D model

usdz File

USDZ format 3D model

blend File

Blender format 3D model

stl File

STL format 3D model

TextureFiles#

base_color File* required

Base color texture

metallic File

Metallic texture (PBR)

normal File

Normal texture (PBR)

roughness File

Roughness texture (PBR)

File#

url string* required

The URL where the file can be downloaded from.

content_type string

The mime type of the file.

file_name string

The name of the file. It will be auto-generated if not provided.

file_size integer

The size of the file in bytes.

BasicAnimations#

walking_glb File

Walking animation in GLB format

walking_fbx File

Walking animation in FBX format

walking_armature_glb File

Walking armature only in GLB format

running_glb File

Running animation in GLB format

running_fbx File

Running animation in FBX format

running_armature_glb File

Running armature only in GLB format

AnimationClip#

action_id integer* required

The Meshy animation preset action ID applied to this clip.

animation_glb File

Animated 3D model in GLB format for this clip.

animation_fbx File

Animated 3D model in FBX format for this clip.

Related Models