DocsBlogPricingEnterpriseCareersResearch Grants
Log-inSign-up

Avatars Text to Video

veed/avatars/text-to-video
Generate high-quality videos with UGC-like avatars from text
Inference
Commercial use
Partner
PlaygroundAPIExamples

About

Text To Video

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("veed/avatars/text-to-video", {
  input: {
    avatar_id: "emily_vertical_primary",
    text: "
  Ever wondered how to get that flawless glow?
  Introducing our new skincare line, designed for real life.
  Step one: Cleanse with our gentle, nourishing formula.
  Step two: Apply our hydrating serum for that dewy look.
  Step three: Lock it in with our lightweight moisturizer.
  Feel the difference with every application.
  See the glow? That's the magic of our skincare.
  Use code 'GLOW20' for an exclusive discount.
  Join the skincare revolution today!
  "
  },
  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("veed/avatars/text-to-video", {
  input: {
    avatar_id: "emily_vertical_primary",
    text: "
  Ever wondered how to get that flawless glow?
  Introducing our new skincare line, designed for real life.
  Step one: Cleanse with our gentle, nourishing formula.
  Step two: Apply our hydrating serum for that dewy look.
  Step three: Lock it in with our lightweight moisturizer.
  Feel the difference with every application.
  See the glow? That's the magic of our skincare.
  Use code 'GLOW20' for an exclusive discount.
  Join the skincare revolution today!
  "
  },
  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("veed/avatars/text-to-video", {
  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("veed/avatars/text-to-video", {
  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#

avatar_id AvatarIdEnum* required

The avatar to use for the video

Possible enum values: emily_vertical_primary, emily_vertical_secondary, marcus_vertical_primary, marcus_vertical_secondary, mira_vertical_primary, mira_vertical_secondary, jasmine_vertical_primary, jasmine_vertical_secondary, jasmine_vertical_walking, aisha_vertical_walking, elena_vertical_primary, elena_vertical_secondary, any_male_vertical_primary, any_female_vertical_primary, any_male_vertical_secondary, any_female_vertical_secondary, any_female_vertical_walking, emily_primary, emily_side, marcus_primary, marcus_side, aisha_walking, elena_primary, elena_side, any_male_primary, any_female_primary, any_male_side, any_female_side

text string* required
{
  "avatar_id": "emily_vertical_primary",
  "text": "\nEver wondered how to get that flawless glow? \nIntroducing our new skincare line, designed for real life. \nStep one: Cleanse with our gentle, nourishing formula. \nStep two: Apply our hydrating serum for that dewy look. \nStep three: Lock it in with our lightweight moisturizer. \nFeel the difference with every application. \nSee the glow? That's the magic of our skincare. \nUse code 'GLOW20' for an exclusive discount. \nJoin the skincare revolution today!\n"
}

Output#

video File* required
{
  "video": {
    "content_type": "video/mp4",
    "url": "https://v3.fal.media/files/panda/kt9d4vZ8Mfw_WzYnvr2Q0_tmp0ir4znsr.mp4"
  }
}

Other types#

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.

Related Models