Pixverse | Image to Video

fal-ai/pixverse/v4/effects

Generate high quality video clips with different effects using PixVerse v4

Inference

Commercial use

Partner

Schema

Playground API

About

Create Effect Video V4

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/pixverse/v4/effects", {
  input: {
    effect: "Kiss Me AI"
  },
  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"
});

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#

Long-running requests

For long-running requests, such as training jobs or models with slower inference times, it is recommended to check the Queue status and rely on Webhooks instead of blocking while waiting for the result.

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/pixverse/v4/effects", {
  input: {
    effect: "Kiss Me AI"
  },
  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/pixverse/v4/effects", {
  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/pixverse/v4/effects", {
  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#

effect EffectEnum* required

The effect to apply to the video

Possible enum values: Kiss Me AI, Kiss, Muscle Surge, Warmth of Jesus, Anything, Robot, The Tiger Touch, Hug, Holy Wings, Hulk, Venom, Microwave

image_url string

Optional URL of the image to use as the first frame. If not provided, generates from text

resolution ResolutionEnum

The resolution of the generated video. Default value: "720p"

Possible enum values: 360p, 540p, 720p, 1080p

duration DurationEnum

The duration of the generated video in seconds Default value: "5"

Possible enum values: 5, 8

negative_prompt string

Negative prompt to be used for the generation Default value: ""

{
  "effect": "Kiss Me AI",
  "image_url": "https://v3.fal.media/files/koala/q5ahL3KS7ikt3MvpNUG8l_image%20(72).webp",
  "resolution": "720p",
  "duration": "5"
}

Output#

video File* required

The generated video

{
  "video": {
    "file_size": 3232402,
    "file_name": "output.mp4",
    "content_type": "video/mp4",
    "url": "https://fal.media/files/koala/awGY1lJd7lVsqQeSqjWqn_output.mp4"
  }
}

Other types#

TextToVideoRequest#

prompt string* required

aspect_ratio AspectRatioEnum

The aspect ratio of the generated video Default value: "16:9"

Possible enum values: 16:9, 4:3, 1:1, 3:4, 9:16

resolution ResolutionEnum

The resolution of the generated video Default value: "720p"

Possible enum values: 360p, 540p, 720p, 1080p

duration DurationEnum

The duration of the generated video in seconds. 8s videos cost double. 1080p videos are limited to 5 seconds Default value: "5"

Possible enum values: 5, 8

negative_prompt string

Negative prompt to be used for the generation Default value: ""

style StyleEnum

The style of the generated video

Possible enum values: anime, 3d_animation, clay, comic, cyberpunk

seed integer

The same seed and the same prompt given to the same version of the model will output the same video every time.

I2VOutputV4#

video File* required

The generated video

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.

file_data string

File data

TransitionRequest#

prompt string* required

The prompt for the transition

aspect_ratio AspectRatioEnum

The aspect ratio of the generated video Default value: "16:9"

Possible enum values: 16:9, 4:3, 1:1, 3:4, 9:16

resolution ResolutionEnum

The resolution of the generated video Default value: "720p"

Possible enum values: 360p, 540p, 720p, 1080p

duration DurationEnum

The duration of the generated video in seconds Default value: "5"

Possible enum values: 5, 8

negative_prompt string

Negative prompt to be used for the generation Default value: ""

style StyleEnum

The style of the generated video

Possible enum values: anime, 3d_animation, clay, comic, cyberpunk

seed integer

The same seed and the same prompt given to the same version of the model will output the same video every time.

first_image_url string* required

URL of the image to use as the first frame

last_image_url string* required

URL of the image to use as the last frame

FastTextToVideoRequest#

prompt string* required

aspect_ratio AspectRatioEnum

The aspect ratio of the generated video Default value: "16:9"

Possible enum values: 16:9, 4:3, 1:1, 3:4, 9:16

resolution ResolutionEnum

The resolution of the generated video Default value: "720p"

Possible enum values: 360p, 540p, 720p

negative_prompt string

Negative prompt to be used for the generation Default value: ""

style StyleEnum

The style of the generated video

Possible enum values: anime, 3d_animation, clay, comic, cyberpunk

seed integer

The same seed and the same prompt given to the same version of the model will output the same video every time.

ImageToVideoRequest#

prompt string* required

aspect_ratio AspectRatioEnum

The aspect ratio of the generated video Default value: "16:9"

Possible enum values: 16:9, 4:3, 1:1, 3:4, 9:16

resolution ResolutionEnum

The resolution of the generated video Default value: "720p"

Possible enum values: 360p, 540p, 720p, 1080p

duration DurationEnum

The duration of the generated video in seconds. 8s videos cost double. 1080p videos are limited to 5 seconds Default value: "5"

Possible enum values: 5, 8

negative_prompt string

Negative prompt to be used for the generation Default value: ""

style StyleEnum

The style of the generated video

Possible enum values: anime, 3d_animation, clay, comic, cyberpunk

seed integer

The same seed and the same prompt given to the same version of the model will output the same video every time.

image_url string* required

URL of the image to use as the first frame

FastImageToVideoRequestV4#

prompt string* required

aspect_ratio AspectRatioEnum

The aspect ratio of the generated video Default value: "16:9"

Possible enum values: 16:9, 4:3, 1:1, 3:4, 9:16

resolution ResolutionEnum

The resolution of the generated video Default value: "720p"

Possible enum values: 360p, 540p, 720p

negative_prompt string

Negative prompt to be used for the generation Default value: ""

style StyleEnum

The style of the generated video

Possible enum values: anime, 3d_animation, clay, comic, cyberpunk

seed integer

The same seed and the same prompt given to the same version of the model will output the same video every time.

image_url string* required

URL of the image to use as the first frame

VideoOutputV4#

video File* required

The generated video

ImageToVideoRequestV4#

prompt string* required

aspect_ratio AspectRatioEnum

The aspect ratio of the generated video Default value: "16:9"

Possible enum values: 16:9, 4:3, 1:1, 3:4, 9:16

resolution ResolutionEnum

The resolution of the generated video Default value: "720p"

Possible enum values: 360p, 540p, 720p, 1080p

duration DurationEnum

The duration of the generated video in seconds. 8s videos cost double. 1080p videos are limited to 5 seconds Default value: "5"

Possible enum values: 5, 8

negative_prompt string

Negative prompt to be used for the generation Default value: ""

style StyleEnum

The style of the generated video

Possible enum values: anime, 3d_animation, clay, comic, cyberpunk

seed integer

The same seed and the same prompt given to the same version of the model will output the same video every time.

image_url string* required

URL of the image to use as the first frame

FastImageToVideoRequest#

prompt string* required

aspect_ratio AspectRatioEnum

The aspect ratio of the generated video Default value: "16:9"

Possible enum values: 16:9, 4:3, 1:1, 3:4, 9:16

resolution ResolutionEnum

The resolution of the generated video Default value: "720p"

Possible enum values: 360p, 540p, 720p

negative_prompt string

Negative prompt to be used for the generation Default value: ""

style StyleEnum

The style of the generated video

Possible enum values: anime, 3d_animation, clay, comic, cyberpunk

seed integer

The same seed and the same prompt given to the same version of the model will output the same video every time.

image_url string* required

URL of the image to use as the first frame

Table of contents

1. Calling the API

2. Authentication

3. Queue

4. Files

5. Schema

About

1. Calling the API#

Install the client#

Migrate to @fal-ai/client

Setup your API Key#

Submit a request#

2. Authentication#

API Key#

Protect your API Key

3. Queue#

Long-running requests

Submit a request#

Fetch request status#

Get the result#

4. Files#

Data URI (base64)#

Hosted files (URL)#

Uploading files#

Auto uploads

5. Schema#

Input#

Output#

Other types#

TextToVideoRequest#

I2VOutputV4#

File#

TransitionRequest#

FastTextToVideoRequest#

ImageToVideoRequest#

FastImageToVideoRequestV4#

VideoOutputV4#

ImageToVideoRequestV4#

FastImageToVideoRequest#

Related Models

Pixverse Image to Video

Table of contents

1. Calling the API

2. Authentication

3. Queue

4. Files

5. Schema

About

1. Calling the API#

Install the client#

Migrate to @fal-ai/client

Setup your API Key#

Submit a request#

2. Authentication#

API Key#

Protect your API Key

3. Queue#

Long-running requests

Submit a request#

Fetch request status#

Get the result#

4. Files#

Data URI (base64)#

Hosted files (URL)#

Uploading files#

Auto uploads

5. Schema#

Input#

Output#

Other types#

TextToVideoRequest#

I2VOutputV4#

File#

TransitionRequest#

FastTextToVideoRequest#

ImageToVideoRequest#

FastImageToVideoRequestV4#

VideoOutputV4#

ImageToVideoRequestV4#

FastImageToVideoRequest#

Related Models