GPT Image 2 is now on fal! 🚀
Docs
Log-inSign-up

fal-ai/lyra-2/splat

Lyra 2.0 is an image-to-video model that turns a single image into an explorable 3D-style video with camera-controlled motion.
Learn more about Lyra 2
Inference
Commercial use
Schema
LLMs
PlaygroundAPI

Table of contents

About

Splat

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/lyra-2/splat", {
  input: {
    video_url: "https://v3b.fal.media/files/b/0a972e2c/6ACGX02AxQXhC1t9BED4b_tmpoufr9iug.mp4"
  },
  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/lyra-2/splat", {
  input: {
    video_url: "https://v3b.fal.media/files/b/0a972e2c/6ACGX02AxQXhC1t9BED4b_tmpoufr9iug.mp4"
  },
  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/lyra-2/splat", {
  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/lyra-2/splat", {
  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#

video_url string* required

URL of a Lyra-generated or Lyra-compatible exploration video. Best results come from videos produced by the /zoom endpoint.

max_frames integer

Maximum number of input frames to process. Additional frames are ignored to keep reconstruction latency and memory use bounded. Default value: 161

da3_max_frames integer

Maximum number of uniformly sampled views passed to the DA3 reconstruction stage. Default value: 81

gs_down_ratio integer

Gaussian-splat feature downsampling ratio. Higher values are usually faster and lighter but may reduce detail. Default value: 2

render_chunk_size integer

Number of views to render per chunk. Increase for speed if you have memory headroom. Default value: 4

use_da3_render_pose boolean

Render with DA3-aligned predicted poses instead of raw VIPE poses. Default value: true

no_vipe boolean

Skip VIPE pose estimation and let DA3 predict poses directly. Useful as a fallback when VIPE struggles, but usually less stable.

vipe_full_mode boolean

Use VIPE full mode for pose estimation. Usually slower, but can help on harder camera motion.

{
  "video_url": "https://v3b.fal.media/files/b/0a972e2c/6ACGX02AxQXhC1t9BED4b_tmpoufr9iug.mp4",
  "max_frames": 161,
  "da3_max_frames": 81,
  "gs_down_ratio": 2,
  "render_chunk_size": 4,
  "use_da3_render_pose": true
}

Output#

video VideoFile* required

Rendered flythrough preview of the reconstructed scene.

scene_ply File* required

Reconstructed Gaussian scene in PLY format.

timings Timings

Per-stage timing breakdown (seconds).

processed_frame_count integer* required

Number of input frames used for reconstruction and rendering.

{
  "video": {
    "url": "https://v3b.fal.media/files/b/0a972e2c/6ACGX02AxQXhC1t9BED4b_tmpoufr9iug.mp4",
    "content_type": "video/mp4"
  },
  "scene_ply": {
    "url": "https://v3b.fal.media/files/b/0a9749d1/yEnEr6MzfP_PLKKiugq5q_reconstructed_scene.ply",
    "content_type": "model/ply"
  }
}

Other types#

VideoFile#

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.

width integer

The width of the video

height integer

The height of the video

fps float

The FPS of the video

duration float

The duration of the video

num_frames integer

The number of frames in the 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.

Related Models