Pika Text to Video Turbo (v2) Text to Video
About
Pika Turbo Text-to-Video Generation.
Generates a video from text description using the Pika Turbo model.
1. Calling the API#
Install the client#
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/clientMigrate 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/turbo/text-to-video", {
input: {
prompt: "A luxurious tea scene where a luxury brand teapot pours tea into an oversized luxury cup. Steam rises, creating an ethereal moment. camera dolly in"
},
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/pika/v2/turbo/text-to-video", {
input: {
prompt: "A luxurious tea scene where a luxury brand teapot pours tea into an oversized luxury cup. Steam rises, creating an ethereal moment. camera dolly in"
},
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/turbo/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/turbo/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* requiredseedΒ integerThe seed for the random number generator
negative_promptΒ stringA negative prompt to guide the model Default value: ""
aspect_ratioΒ AspectRatioEnumThe 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Β ResolutionEnumThe resolution of the generated video Default value: "720p"
Possible enum values: 720p, 1080p
durationΒ integerThe duration of the generated video in seconds Default value: 5
{
"prompt": "A luxurious tea scene where a luxury brand teapot pours tea into an oversized luxury cup. Steam rises, creating an ethereal moment. camera dolly in",
"aspect_ratio": "16:9",
"resolution": "720p",
"duration": 5
}Output#
The generated video
{
"video": {
"url": "https://storage.googleapis.com/falserverless/example_outputs/pika/pika_t2v_v2_turbo_output.mp4"
}
}Other types#
Pika22ImageToVideoRequest#
image_urlΒ string* requiredURL of the image to use as the first frame
promptΒ string* requiredseedΒ integerThe seed for the random number generator
negative_promptΒ stringA negative prompt to guide the model Default value: ""
resolutionΒ ResolutionEnumThe resolution of the generated video Default value: "720p"
Possible enum values: 720p, 1080p
durationΒ DurationEnumThe duration of the generated video in seconds Default value: "5"
Possible enum values: 5, 10
Pika22KeyframesToVideoRequest#
URLs of keyframe images (2-5 images) to create transitions between
Configuration for each transition. Length must be len(image_urls) - 1. Total duration of all transitions must not exceed 25 seconds. If not provided, uses default 5-second transitions with the global prompt.
promptΒ stringDefault prompt for all transitions. Individual transition prompts override this.
negative_promptΒ stringA negative prompt to guide the model Default value: ""
seedΒ integerThe seed for the random number generator
resolutionΒ ResolutionEnumThe resolution of the generated video Default value: "720p"
Possible enum values: 720p, 1080p
File#
urlΒ string* requiredThe URL where the file can be downloaded from.
content_typeΒ stringThe mime type of the file.
file_nameΒ stringThe name of the file. It will be auto-generated if not provided.
file_sizeΒ integerThe size of the file in bytes.
file_dataΒ stringFile data
Pika22PikascenesRequest#
URLs of images to combine into a video
promptΒ string* requiredText prompt describing the desired video
negative_promptΒ stringA negative prompt to guide the model Default value: "ugly, bad, terrible"
seedΒ integerThe seed for the random number generator
aspect_ratioΒ AspectRatioEnumThe 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Β ResolutionEnumThe resolution of the generated video Default value: "1080p"
Possible enum values: 720p, 1080p
durationΒ DurationEnumThe duration of the generated video in seconds Default value: "5"
Possible enum values: 5, 10
ingredients_modeΒ IngredientsModeEnumMode for integrating multiple images. Precise mode is more accurate, creative mode is more creative. Default value: "precise"
Possible enum values: precise, creative
KeyframeTransition#
durationΒ integerDuration of this transition in seconds Default value: 5
promptΒ stringSpecific prompt for this transition. Overrides the global prompt if provided.
Pika22TextToVideoRequest#
promptΒ string* requiredseedΒ integerThe seed for the random number generator
negative_promptΒ stringA negative prompt to guide the model Default value: "ugly, bad, terrible"
aspect_ratioΒ AspectRatioEnumThe 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Β ResolutionEnumThe resolution of the generated video Default value: "720p"
Possible enum values: 1080p, 720p
durationΒ DurationEnumThe duration of the generated video in seconds Default value: "5"
Possible enum values: 5, 10
PikaswapsRequest#
video_urlΒ string* requiredURL of the input video
image_urlΒ stringURL of the image to swap with
modify_regionΒ stringPlaintext description of the object/region to modify
promptΒ stringText prompt describing the modification
negative_promptΒ stringNegative prompt to guide the model
seedΒ integerThe seed for the random number generator
CollectionToVideoRequest#
List of images to use for video generation
promptΒ string* requiredseedΒ integerThe seed for the random number generator
negative_promptΒ stringA negative prompt to guide the model Default value: ""
aspect_ratioΒ AspectRatioEnumThe 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Β ResolutionEnumThe resolution of the generated video Default value: "720p"
Possible enum values: 720p, 1080p
durationΒ integerThe duration of the generated video in seconds Default value: 5
ingredients_modeΒ IngredientsModeEnumMode for integrating multiple images Default value: "creative"
Possible enum values: creative, precise
PikaImage#
image_urlΒ string* requiredPikadditionsRequest#
video_urlΒ string* requiredURL of the input video
image_urlΒ string* requiredURL of the image to add
promptΒ stringText prompt describing what to add
negative_promptΒ stringNegative prompt to guide the model
seedΒ integerThe seed for the random number generator
PikaffectsRequest#
image_urlΒ string* requiredURL of the input image
pikaffectΒ PikaffectEnum* requiredThe Pikaffect to apply
Possible enum values: Cake-ify, Crumble, Crush, Decapitate, Deflate, Dissolve, Explode, Eye-pop, Inflate, Levitate, Melt, Peel, Poke, Squish, Ta-da, Tear
promptΒ stringText prompt to guide the effect
negative_promptΒ stringNegative prompt to guide the model
seedΒ integerThe seed for the random number generator