DocsBlogPricingEnterpriseCareersResearch Grants
Log-inSign-up

Ovi Text to Video Text to Video

fal-ai/ovi
A unified paradigm for audio-video generation
Inference
Commercial use
PlaygroundAPI

About

Generate a video based on the provided request parameters.

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("fal-ai/ovi", {
  input: {
    prompt: "A close-up of someone's face as they pet a cat, their hands stroking the soft fur in the foreground. Their affectionate expression shows as the cat purrs contentedly in their lap. They say, <S>This little guy has been with me for eight years now. He knows exactly when I need comfort. Animals are pretty amazing that way.<E>.<AUDCAP>Affectionate voice with cat purring and gentle petting sounds<ENDAUDCAP>"
  },
  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("fal-ai/ovi", {
  input: {
    prompt: "A close-up of someone's face as they pet a cat, their hands stroking the soft fur in the foreground. Their affectionate expression shows as the cat purrs contentedly in their lap. They say, <S>This little guy has been with me for eight years now. He knows exactly when I need comfort. Animals are pretty amazing that way.<E>.<AUDCAP>Affectionate voice with cat purring and gentle petting sounds<ENDAUDCAP>"
  },
  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/ovi", {
  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/ovi", {
  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#

prompt string* required

The text prompt to guide video generation.

negative_prompt string

Negative prompt for video generation. Default value: "jitter, bad hands, blur, distortion"

num_inference_steps integer

The number of inference steps. Default value: 30

audio_negative_prompt string

Negative prompt for audio generation. Default value: "robotic, muffled, echo, distorted"

seed integer

Random seed for reproducibility. If None, a random seed is chosen.

resolution ResolutionEnum

Resolution of the generated video in W:H format. One of (512x992, 992x512, 960x512, 512x960, 720x720, or 448x1120). Default value: "992x512"

Possible enum values: 512x992, 992x512, 960x512, 512x960, 720x720, 448x1120, 1120x448

{
  "prompt": "A close-up of someone's face as they pet a cat, their hands stroking the soft fur in the foreground. Their affectionate expression shows as the cat purrs contentedly in their lap. They say, <S>This little guy has been with me for eight years now. He knows exactly when I need comfort. Animals are pretty amazing that way.<E>.<AUDCAP>Affectionate voice with cat purring and gentle petting sounds<ENDAUDCAP>",
  "negative_prompt": "jitter, bad hands, blur, distortion",
  "num_inference_steps": 30,
  "audio_negative_prompt": "robotic, muffled, echo, distorted",
  "resolution": "992x512"
}

Output#

video File

The generated video file.

seed integer* required

The seed used for generation.

{
  "video": {
    "url": "https://storage.googleapis.com/falserverless/example_inputs/ovi_t2v_output.mp4"
  }
}

Other types#

OviI2VRequest#

prompt string* required

The text prompt to guide video generation.

negative_prompt string

Negative prompt for video generation. Default value: "jitter, bad hands, blur, distortion"

num_inference_steps integer

The number of inference steps. Default value: 30

audio_negative_prompt string

Negative prompt for audio generation. Default value: "robotic, muffled, echo, distorted"

seed integer

Random seed for reproducibility. If None, a random seed is chosen.

image_url string* required

The image URL to guide video generation.

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.

OviI2VResponse#

video File

The generated video file.

seed integer* required

The seed used for generation.

Related Models