Lightx | Video to Video

fal-ai/lightx/relight

Use tlightx capabilities to relight and recamera your videos.

Inference

Commercial use

Schema

LLMs

Playground API

About

Relight

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/lightx/relight", {
  input: {
    video_url: "https://storage.googleapis.com/falserverless/example_inputs/lightx_video.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"
});

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/lightx/relight", {
  input: {
    video_url: "https://storage.googleapis.com/falserverless/example_inputs/lightx_video.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/lightx/relight", {
  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/lightx/relight", {
  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#

video_url string* required

URL of the input video.

prompt string

Optional text prompt. If omitted, Light-X will auto-caption the video.

seed integer

Random seed for reproducibility. If None, a random seed is chosen.

relit_cond_type RelitCondTypeEnum

Relight condition type. Default value: "ic"

Possible enum values: ic, ref, hdr, bg

relight_parameters RelightParameters

Relighting parameters (required for ic/bg condition types).

relit_cond_img_url string

URL of conditioning image (required for ref/hdr).

ref_id integer

Frame index to use as referencen to relight the video with reference.

{
  "video_url": "https://storage.googleapis.com/falserverless/example_inputs/lightx_video.mp4",
  "relit_cond_type": "ic",
  "relight_parameters": {
    "relight_prompt": "Sunlight",
    "bg_source": "Right",
    "use_sky_mask": false,
    "cfg": 2
  },
  "relit_cond_img_url": "https://storage.googleapis.com/falserverless/example_inputs/lightx_image.png"
}

Output#

video File* required

The generated video file.

seed integer* required

The seed used for generation.

input_video File

Optional: normalized/processed input video (if produced by the pipeline).

viz_video File

Optional: visualization/debug video (if produced by the pipeline).

{
  "video": "https://v3b.fal.media/files/b/0a8715c9/x378fHboeiGD6j_0nbWlJ_gen.mp4"
}

Other types#

TrajectoryParameters#

theta list<float>* required

Horizontal rotation angles (degrees) for each keyframe.

phi list<float>* required

Vertical rotation angles (degrees) for each keyframe.

radius list<float>* required

Camera distance scaling factors for each keyframe.

LightXRecameraRequest#

video_url string* required

URL of the input video.

prompt string

Optional text prompt. If omitted, Light-X will auto-caption the video.

seed integer

Random seed for reproducibility. If None, a random seed is chosen.

camera CameraEnum

Camera control mode. Default value: "traj"

Possible enum values: traj, target

mode ModeEnum

Camera motion mode. Default value: "gradual"

Possible enum values: gradual, bullet, direct, dolly-zoom

trajectory TrajectoryParameters

Camera trajectory parameters (required for recamera mode).

target_pose list<float>

Target camera pose [theta, phi, radius, x, y] (required when camera='target').

LightXRelightRecameraRequest#

video_url string* required

URL of the input video.

prompt string

Optional text prompt. If omitted, Light-X will auto-caption the video.

seed integer

Random seed for reproducibility. If None, a random seed is chosen.

camera CameraEnum

Camera control mode. Default value: "traj"

Possible enum values: traj, target

mode ModeEnum

Camera motion mode. Default value: "gradual"

Possible enum values: gradual, bullet, direct, dolly-zoom

trajectory TrajectoryParameters

Camera trajectory parameters (required for recamera mode).

target_pose list<float>

Target camera pose [theta, phi, radius, x, y] (required when camera='target').

relit_cond_type RelitCondTypeEnum

Relight condition type. Default value: "ic"

Possible enum values: ic, ref, hdr, bg

relight_parameters RelightParameters

Relighting parameters (required for ic/bg condition types).

relit_cond_img_url string

URL of conditioning image (required for ref/hdr).

ref_id integer

Frame index to use as referencen to relight the video with reference.

RelightParameters#

relight_prompt string* required

Text prompt describing the desired lighting condition.

bg_source BgSourceEnum

Direction of the light source. Default value: "Left"

Possible enum values: Left, Right, Top, Bottom

cfg float

Classifier-free guidance scale for relighting. Default value: 2

use_sky_mask boolean

Whether to use sky masking for outdoor scenes.

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

Lightx Video 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#

TrajectoryParameters#

LightXRecameraRequest#

LightXRelightRecameraRequest#

RelightParameters#

File#