Loading API documentation
Predict Pose Image
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/live-portrait/image", {
input: {
image_url: "https://storage.googleapis.com/falserverless/model_tests/live-portrait/XKEmk3mAzGHUjK3qqH-UL.jpeg"
},
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/live-portrait/image", {
input: {
image_url: "https://storage.googleapis.com/falserverless/model_tests/live-portrait/XKEmk3mAzGHUjK3qqH-UL.jpeg"
},
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/live-portrait/image", {
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/live-portrait/image", {
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.
image_url string* requiredURL of the image to be animated
blink floatAmount to blink the eyes
eyebrow floatAmount to raise or lower eyebrows
wink floatAmount to wink
pupil_x floatAmount to move pupils horizontally
pupil_y floatAmount to move pupils vertically
aaa floatAmount to open mouth in 'aaa' shape
eee floatAmount to shape mouth in 'eee' position
woo floatAmount to shape mouth in 'woo' position
smile floatAmount to smile
rotate_pitch floatAmount to rotate the face in pitch
rotate_yaw floatAmount to rotate the face in yaw
rotate_roll floatAmount to rotate the face in roll
flag_pasteback booleanWhether to paste-back/stitch the animated face cropping from the face-cropping space to the original image space. Default value: true
flag_do_crop booleanWhether to crop the source portrait to the face-cropping space. Default value: true
flag_do_rot booleanWhether to conduct the rotation when flag_do_crop is True. Default value: true
flag_lip_zero booleanWhether to set the lip to closed state before animation. Only takes effect when flag_eye_retargeting and flag_lip_retargeting are False. Default value: true
dsize integerSize of the output image. Default value: 512
scale floatScaling factor for the face crop. Default value: 2.3
vx_ratio floatHorizontal offset ratio for face crop.
vy_ratio floatVertical offset ratio for face crop. Positive values move up, negative values move down. Default value: -0.125
enable_safety_checker booleanWhether to enable the safety checker. If enabled, the model will check if the input image contains a face before processing it. The safety checker will process the input image
output_format OutputFormatEnumOutput format Default value: "jpeg"
Possible enum values: jpeg, png
{
"image_url": "https://storage.googleapis.com/falserverless/model_tests/live-portrait/XKEmk3mAzGHUjK3qqH-UL.jpeg",
"flag_pasteback": true,
"flag_do_crop": true,
"flag_do_rot": true,
"flag_lip_zero": true,
"dsize": 512,
"scale": 2.3,
"vy_ratio": -0.125,
"output_format": "jpeg"
}The generated image file.
{
"image": {
"url": "",
"content_type": "image/png",
"file_name": "z9RV14K95DvU.png",
"file_size": 4404019,
"width": 1024,
"height": 1024
}
}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.
width integerThe width of the image in pixels.
height integerThe height of the image in pixels.