Loading API documentation
Rigging Animations
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/clientSet 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("hyper3d/rigging/animations", {
input: {},
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"
});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("hyper3d/rigging/animations", {
input: {},
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("hyper3d/rigging/animations", {
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("hyper3d/rigging/animations", {
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);Read more about file handling in our file upload guide.
category EnumFilter stock animations by category. Omit to list all categories.
Possible enum values: human, canine, bird, fish, heavyhooved, leanhooved, lizard, rodentia, seaturtle
{}Available stock animations in source catalog order. Use animation_id in animation_presets.
{
"animations": [
{
"animation_id": "",
"category": "human",
"display_name": "",
"content_description": "",
"loop": {
"kind": "none",
"alignment": "none"
}
}
]
}animation_id string* requiredcategory CategoryEnum* requiredPossible enum values: human, canine, bird, fish, heavyhooved, leanhooved, lizard, rodentia, seaturtle
display_name string* requiredcontent_description string* requiredframes integer* requiredSamples at 30 FPS, including both endpoints.
duration_seconds float* requiredSample duration in seconds.
kind KindEnum* requiredPossible enum values: none, in_place, travel
alignment AlignmentEnum* requiredPossible enum values: none, duplicate, next
period_frames integer* requiredLoop period at 30 FPS, if available.
World-space displacement per loop in meters, in x, y, z order.