Loading API documentation
Auto-rig and optionally animate any 3D humanoid model (GLB format).
Accepts any publicly accessible GLB URL — works with models generated by Hunyuan, Trellis, Meshy, or any other 3D generation tool.
Features:
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/clientThe @fal-ai/serverless-client package has been deprecated in favor of @fal-ai/client. Install the new package and update your imports — see client setup.
Set FAL_KEY as an environment variable in your runtime.
export FAL_KEY="YOUR_API_KEY"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", {
input: {
model_url: "https://storage.googleapis.com/falserverless/model_tests/video_models/base_basic_shaded.glb"
},
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);The API uses an API Key for authentication. It is recommended you set the FAL_KEY environment variable in your runtime when possible.
import { fal } from "@fal-ai/client";
fal.config({
credentials: "YOUR_FAL_KEY"
});When running code on the client-side (e.g. in a browser, mobile app or GUI applications), make sure to not expose your FAL_KEY. Instead, use a server-side proxy to make requests to the API. For more information, check out our server-side integration guide.
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", {
input: {
model_url: "https://storage.googleapis.com/falserverless/model_tests/video_models/base_basic_shaded.glb"
},
webhookUrl: "https://optional.webhook.url/for/results",
});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", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b",
logs: true,
});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", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});
console.log(result.data);
console.log(result.requestId);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.
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.
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.
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);The client will auto-upload the file for you if you pass a binary object (e.g. File, Data).
Read more about file handling in our file upload guide.
model_url string* requiredURL of a 3D model in GLB format to rig. 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 floatApproximate height of the character in meters. Default value: 1.7
enable_animation booleanApply an animation preset to the rigged model.
animation_action_id integerAnimation preset ID from Meshy's library. Only used when enable_animation is true; in that case it must be in [0, 696] (0 is the "Idle" preset) and is otherwise rejected with a 422. See https://docs.meshy.ai/en/api/animation-library for available action IDs. Default value: 92
enable_safety_checker booleanIf 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_id": 92,
"enable_safety_checker": true
}Rigged character in GLB format.
Rigged character in FBX format.
Basic walking and running animations included with rigging.
Animated 3D model in GLB format. Only present when enable_animation is true.
Animated 3D model in FBX format. Only present when enable_animation is true.
rig_task_id stringMeshy rigging task ID.
{}Walking animation in GLB format
Walking animation in FBX format
Walking armature only in GLB format
Running animation in GLB format
Running animation in FBX format
Running armature only in GLB format
url string* requiredThe URL where the file can be downloaded from.
content_type stringThe mime type of the file.
file_name stringThe name of the file. It will be auto-generated if not provided.
file_size integerThe size of the file in bytes.