Pika Text to Video (v2.2) | Text to Video

fal-ai/pika/v2.2/text-to-video

Pika v2.2 creates videos from a text prompt with high quality output.

Inference

Commercial use

Partner

Schema

Playground API

About

Pika 2.2 Text-to-Video Generation.

Generates a video from text description using the Pika 2.2 model. This is Pika's highest quality model with support for resolution and duration options.

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/pika/v2.2/text-to-video", {
  input: {
    prompt: "Sunlight streams down on a woman with flowing auburn hair as she runs effortlessly along a tree-lined street, her joyous expression reflecting the freedom of the moment; the simple, steady camerawork emphasizes her grace and the beauty of the everyday."
  },
  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/pika/v2.2/text-to-video", {
  input: {
    prompt: "Sunlight streams down on a woman with flowing auburn hair as she runs effortlessly along a tree-lined street, her joyous expression reflecting the freedom of the moment; the simple, steady camerawork emphasizes her grace and the beauty of the everyday."
  },
  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/pika/v2.2/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("fal-ai/pika/v2.2/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);

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#

prompt string* required

Default value: undefined

seed integer

The seed for the random number generator Default value: undefined

negative_prompt string

A negative prompt to guide the model Default value: ""

aspect_ratio AspectRatioEnum

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

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

resolution ResolutionEnum

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

Possible enum values: 720p, 1080p

duration integer

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

{
  "prompt": "Sunlight streams down on a woman with flowing auburn hair as she runs effortlessly along a tree-lined street, her joyous expression reflecting the freedom of the moment; the simple, steady camerawork emphasizes her grace and the beauty of the everyday.",
  "aspect_ratio": "16:9",
  "resolution": "720p",
  "duration": 5
}

Output#

video File* required

The generated video Default value: undefined

{
  "video": {
    "url": "https://storage.googleapis.com/falserverless/web-examples/pika/pika%202.2/text-to-video-output.mp4"
  }
}

Other types#

TextToVideoRequest#

prompt string* required

Default value: undefined

seed integer

The seed for the random number generator Default value: undefined

negative_prompt string

A negative prompt to guide the model Default value: ""

aspect_ratio AspectRatioEnum

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

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

resolution ResolutionEnum

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

Possible enum values: 720p, 1080p

duration integer

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

Pika22ImageToVideoRequest#

image_url string* required

URL of the image to use as the first frame Default value: undefined

prompt string* required

Default value: undefined

seed integer

The seed for the random number generator Default value: undefined

negative_prompt string

A negative prompt to guide the model Default value: ""

resolution ResolutionEnum

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

Possible enum values: 720p, 1080p

duration integer

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

PikaswapsRequest#

video_url string* required

URL of the input video Default value: undefined

image_url string

URL of the image to swap with Default value: undefined

modify_region string

Plaintext description of the object/region to modify Default value: undefined

prompt string

Text prompt describing the modification Default value: undefined

negative_prompt string

Negative prompt to guide the model Default value: undefined

seed integer

The seed for the random number generator Default value: undefined

CollectionToVideoRequest#

images list<PikaImage>* required

List of images to use for video generation Default value: undefined

prompt string* required

Default value: undefined

seed integer

The seed for the random number generator Default value: undefined

negative_prompt string

A negative prompt to guide the model Default value: ""

aspect_ratio AspectRatioEnum

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

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

resolution ResolutionEnum

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

Possible enum values: 720p, 1080p

duration integer

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

ingredients_mode IngredientsModeEnum

Mode for integrating multiple images Default value: "creative"

Possible enum values: creative, precise

File#

url string* required

The URL where the file can be downloaded from. Default value: undefined

content_type string

The mime type of the file. Default value: undefined

file_name string

The name of the file. It will be auto-generated if not provided. Default value: undefined

file_size integer

The size of the file in bytes. Default value: undefined

file_data string

File data Default value: undefined

ImageToVideoRequest#

image_url string* required

URL of the image to use as the first frame Default value: undefined

prompt string* required

Default value: undefined

seed integer

The seed for the random number generator Default value: undefined

negative_prompt string

A negative prompt to guide the model Default value: ""

resolution ResolutionEnum

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

Possible enum values: 720p, 1080p

duration integer

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

PikadditionsRequest#

video_url string* required

URL of the input video Default value: undefined

image_url string* required

URL of the image to add Default value: undefined

prompt string

Text prompt describing what to add Default value: undefined

negative_prompt string

Negative prompt to guide the model Default value: undefined

seed integer

The seed for the random number generator Default value: undefined

PikaImage#

image_url string* required

Default value: undefined

PikaffectsRequest#

image_url string* required

URL of the input image Default value: undefined

pikaffect PikaffectEnum* required

The Pikaffect to apply Default value: undefined

Possible enum values: Cake-ify, Crumble, Crush, Decapitate, Deflate, Dissolve, Explode, Eye-pop, Inflate, Levitate, Melt, Peel, Poke, Squish, Ta-da, Tear

prompt string

Text prompt to guide the effect Default value: undefined

negative_prompt string

Negative prompt to guide the model Default value: undefined

seed integer

The seed for the random number generator Default value: undefined

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#

Pika22ImageToVideoRequest#

PikaswapsRequest#

CollectionToVideoRequest#

File#

ImageToVideoRequest#

PikadditionsRequest#

PikaImage#

PikaffectsRequest#

Related Models

Pika Text to Video (v2.2) Text 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#

Pika22ImageToVideoRequest#

PikaswapsRequest#

CollectionToVideoRequest#

File#

ImageToVideoRequest#

PikadditionsRequest#

PikaImage#

PikaffectsRequest#

Related Models