Ai Avatar Image to Video
About
MultiTalk model generates a multi-person conversation video from an image and text inputs. Converts text to speech for each person, generating a realistic conversation scene.
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
Migrate to @fal-ai/client
The @fal-ai/serverless-client
package has been deprecated in favor of @fal-ai/client
. Please check the migration guide for more information.
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/ai-avatar/multi-text", {
input: {
image_url: "https://v3.fal.media/files/koala/vhkIF86hmgNTBll_lF1xI_3c7476642b19435aa763fe3b49cf99c7.png",
first_text_input: "Do you know what are we eating?",
second_text_input: "I dont know I am eating this because our mother gave it to us. I think it is something called milky pie.",
prompt: "Two kids talking on a lunch."
},
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#
import { fal } from "@fal-ai/client";
fal.config({
credentials: "YOUR_FAL_KEY"
});
Protect your API 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.
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/ai-avatar/multi-text", {
input: {
image_url: "https://v3.fal.media/files/koala/vhkIF86hmgNTBll_lF1xI_3c7476642b19435aa763fe3b49cf99c7.png",
first_text_input: "Do you know what are we eating?",
second_text_input: "I dont know I am eating this because our mother gave it to us. I think it is something called milky pie.",
prompt: "Two kids talking on a lunch."
},
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/ai-avatar/multi-text", {
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/ai-avatar/multi-text", {
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);
Auto uploads
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.
5. Schema#
Input#
image_url
string
* requiredURL of the input image. If the input image does not match the chosen aspect ratio, it is resized and center cropped.
first_text_input
string
* requiredThe text input to guide video generation.
second_text_input
string
* requiredThe text input to guide video generation.
voice1
Voice1Enum
The first person's voice to use for speech generation Default value: "Sarah"
Possible enum values: Aria, Roger, Sarah, Laura, Charlie, George, Callum, River, Liam, Charlotte, Alice, Matilda, Will, Jessica, Eric, Chris, Brian, Daniel, Lily, Bill
voice2
Voice2Enum
The second person's voice to use for speech generation Default value: "Roger"
Possible enum values: Aria, Roger, Sarah, Laura, Charlie, George, Callum, River, Liam, Charlotte, Alice, Matilda, Will, Jessica, Eric, Chris, Brian, Daniel, Lily, Bill
prompt
string
* requiredThe text prompt to guide video generation.
num_frames
integer
Number of frames to generate. Must be between 81 to 129 (inclusive). If the number of frames is greater than 81, the video will be generated with 1.25x more billing units. Default value: 191
resolution
ResolutionEnum
Resolution of the video to generate. Must be either 480p or 720p. Default value: "480p"
Possible enum values: 480p, 720p
seed
integer
Random seed for reproducibility. If None, a random seed is chosen. Default value: 81
acceleration
AccelerationEnum
The acceleration level to use for generation. Default value: "regular"
Possible enum values: none, regular, high
{
"image_url": "https://v3.fal.media/files/koala/vhkIF86hmgNTBll_lF1xI_3c7476642b19435aa763fe3b49cf99c7.png",
"first_text_input": "Do you know what are we eating?",
"second_text_input": "I dont know I am eating this because our mother gave it to us. I think it is something called milky pie.",
"voice1": "Sarah",
"voice2": "Roger",
"prompt": "Two kids talking on a lunch.",
"num_frames": 191,
"resolution": "480p",
"seed": 81,
"acceleration": "regular"
}
Output#
The generated video file.
seed
integer
* requiredThe seed used for generation.
{
"video": {
"file_size": 352679,
"file_name": "30b76b90c2164f9a926527497c20832b.mp4",
"content_type": "application/octet-stream",
"url": "https://v3.fal.media/files/zebra/lKMkUvzCqKn-gHC0vyUPP_30b76b90c2164f9a926527497c20832b.mp4"
}
}
Other types#
AvatarSingleAudioResponse#
The generated video file.
seed
integer
* requiredThe seed used for generation.
AvatarSingleAudioRequest#
image_url
string
* requiredURL of the input image. If the input image does not match the chosen aspect ratio, it is resized and center cropped.
audio_url
string
* requiredThe URL of the audio file.
prompt
string
* requiredThe text prompt to guide video generation.
num_frames
integer
Number of frames to generate. Must be between 81 to 129 (inclusive). If the number of frames is greater than 81, the video will be generated with 1.25x more billing units. Default value: 145
resolution
ResolutionEnum
Resolution of the video to generate. Must be either 480p or 720p. Default value: "480p"
Possible enum values: 480p, 720p
seed
integer
Random seed for reproducibility. If None, a random seed is chosen. Default value: 42
acceleration
AccelerationEnum
The acceleration level to use for generation. Default value: "regular"
Possible enum values: none, regular, high
AvatarMultiAudioResponse#
The generated video file.
seed
integer
* requiredThe seed used for generation.
AvatarSingleTextRequest#
image_url
string
* requiredURL of the input image. If the input image does not match the chosen aspect ratio, it is resized and center cropped.
text_input
string
* requiredThe text input to guide video generation.
voice
VoiceEnum
* requiredThe voice to use for speech generation
Possible enum values: Aria, Roger, Sarah, Laura, Charlie, George, Callum, River, Liam, Charlotte, Alice, Matilda, Will, Jessica, Eric, Chris, Brian, Daniel, Lily, Bill
prompt
string
* requiredThe text prompt to guide video generation.
num_frames
integer
Number of frames to generate. Must be between 81 to 129 (inclusive). If the number of frames is greater than 81, the video will be generated with 1.25x more billing units. Default value: 136
resolution
ResolutionEnum
Resolution of the video to generate. Must be either 480p or 720p. Default value: "480p"
Possible enum values: 480p, 720p
seed
integer
Random seed for reproducibility. If None, a random seed is chosen. Default value: 42
acceleration
AccelerationEnum
The acceleration level to use for generation. Default value: "regular"
Possible enum values: none, regular, high
AvatarSingleTextResponse#
The generated video file.
seed
integer
* requiredThe seed used for generation.
File#
url
string
* requiredThe 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.
AvatarMultiAudioPersonRequest#
image_url
string
* requiredURL of the input image. If the input image does not match the chosen aspect ratio, it is resized and center cropped.
first_audio_url
string
* requiredThe URL of the Person 1 audio file.
second_audio_url
string
* requiredThe URL of the Person 2 audio file.
prompt
string
* requiredThe text prompt to guide video generation.
num_frames
integer
Number of frames to generate. Must be between 81 to 129 (inclusive). If the number of frames is greater than 81, the video will be generated with 1.25x more billing units. Default value: 181
resolution
ResolutionEnum
Resolution of the video to generate. Must be either 480p or 720p. Default value: "480p"
Possible enum values: 480p, 720p
seed
integer
Random seed for reproducibility. If None, a random seed is chosen. Default value: 81
use_only_first_audio
boolean
Whether to use only the first audio file.
acceleration
AccelerationEnum
The acceleration level to use for generation. Default value: "regular"
Possible enum values: none, regular, high