Cosmos 3 Super Image to Video API Docs | fal
nvidia/cosmos-3-super/image-to-video
Image to Video
Cosmos3 is a collection of Omnimodal world models capable of generating dynamic, high-quality video, image, audio, and action commands from combinations of text, image, video, and action trajectory inputs.
Inference
Commercial use
About
Generate a video from a first-frame image and prompt using Cosmos3-Super via vLLM-Omni.
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. Install the new package and update your imports — see client setup.
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("nvidia/cosmos-3-super/image-to-video", {
input: {
prompt: "The camera slowly pushes in as the subject turns their head toward the light, hair drifting in a gentle breeze, dust motes floating through warm afternoon sun.",
image_url: "https://storage.googleapis.com/falserverless/example_inputs/hunyuan_i2v.jpg"
},
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("nvidia/cosmos-3-super/image-to-video", {
input: {
prompt: "The camera slowly pushes in as the subject turns their head toward the light, hair drifting in a gentle breeze, dust motes floating through warm afternoon sun.",
image_url: "https://storage.googleapis.com/falserverless/example_inputs/hunyuan_i2v.jpg"
},
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("nvidia/cosmos-3-super/image-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("nvidia/cosmos-3-super/image-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
promptstring* required: Text prompt describing the motion and scene of the video to generate.image_urlstring* required: URL of the conditioning first-frame image for the video.negative_promptstring: Content to steer the generation away from (artifacts, unwanted motion). Defaults to NVIDIA's recommended i2v negative prompt; pass an empty string to disable.enable_prompt_expansionboolean: If true, the Cosmos3-Nano Reasoner rewrites the prompt into the dense caption Cosmos3 was trained on.agentic_max_iterationsinteger: Maximum agentic prompt stages when agentic generation is enabled.agentic_samples_per_iterationinteger: Candidate videos to generate and judge per agentic iteration.agentic_early_stopboolean: Stop the agentic loop early when the critic score clears the strict quality threshold.image_sizeImageSize | Enum: The size of the generated video.num_framesinteger: Number of frames to generate.frames_per_secondinteger: Frames per second of the output video.num_inference_stepsinteger: Number of denoising steps.guidance_scalefloat: Classifier-free guidance scale.seedinteger: The same seed and prompt given to the same model version will produce the same video every time.enable_safety_checkerboolean: Enable content moderation for the input prompt and image.sync_modeboolean: IfTrue, the video is returned as a data URI and the output data won't be available in the request history.
Output
videoVideoFile* required: The generated video.seedinteger* required: The seed used for generation.
Other types
ImageFile
urlstring* required: The URL where the file can be downloaded from.content_typestring: The mime type of the file.file_namestring: The name of the file.file_sizeinteger: The size of the file in bytes.widthinteger: The width of the imageheightinteger: The height of the image
ImageSize
widthinteger: The width of the generated image.heightinteger: The height of the generated image.
VideoFile
urlstring* required: The URL where the file can be downloaded from.content_typestring: The mime type of the file.file_namestring: The name of the file.file_sizeinteger: The size of the file in bytes.widthinteger: The width of the video.heightinteger: The height of the video.fpsfloat: The FPS of the video.durationfloat: The duration of the video.num_framesinteger: The number of frames in the video.