Loading API documentation
ray-3.2 video-to-video editing via the Luma Agents API.
Edits an existing source video according to the prompt (video_edit
operation). loop does not apply to editing an existing clip, so —
unlike text/image-to-video — there is no _reject_unsupported_video_options
check here.
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/clientThe @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.
Set FAL_KEY as an environment variable in your runtime.
export FAL_KEY="YOUR_API_KEY"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("luma/agent/ray/v3.2/video-to-video", {
input: {
prompt: "Restyle the footage as a hand-painted watercolor animation with soft pastel colors.",
video_url: "https://storage.googleapis.com/falserverless/example_inputs/birefnet-video-input.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);The API uses an API Key for authentication. It is recommended you set the FAL_KEY environment variable in your runtime when possible.
import { fal } from "@fal-ai/client";
fal.config({
credentials: "YOUR_FAL_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.
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("luma/agent/ray/v3.2/video-to-video", {
input: {
prompt: "Restyle the footage as a hand-painted watercolor animation with soft pastel colors.",
video_url: "https://storage.googleapis.com/falserverless/example_inputs/birefnet-video-input.mp4"
},
webhookUrl: "https://optional.webhook.url/for/results",
});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("luma/agent/ray/v3.2/video-to-video", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b",
logs: true,
});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("luma/agent/ray/v3.2/video-to-video", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});
console.log(result.data);
console.log(result.requestId);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.
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.
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.
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);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.
prompt string* requiredText prompt describing how to edit the source video.
video_url string* requiredURL of the source video to edit.
user stringOptional opaque identifier for the end user making the request. Used only for abuse attribution; never interpreted by fal.
start_image_url stringOptional URL of an image to use as the edited video's first frame — e.g. a restyled version of the source's opening frame to steer the look of the edit. Leave unset to let the model derive the first frame from the source video.
resolution ResolutionEnumResolution of the edited video. Higher resolutions cost more. Default value: "540p"
Possible enum values: 540p, 720p, 1080p
duration DurationEnumDuration of the edited video. Default value: "5s"
Possible enum values: 5s, 10s
edit_strength EnumHow closely the edit preserves the source video. 'adhere_' stays closest to the source, 'flex_' is balanced, and 'reimagine_*' diverges most. Leave unset to use Luma's default. Cannot be combined with auto_controls.
Possible enum values: adhere_1, adhere_2, adhere_3, flex_1, flex_2, flex_3, reimagine_1, reimagine_2, reimagine_3
auto_controls booleanLet the model derive the edit conditioning schedule from the source video. Cannot be combined with edit_strength.
hdr booleanGenerate an HDR-encoded MP4. Requires HDR access on the account and a resolution of 720p or 1080p.
exr_export booleanAlso export an EXR file alongside the MP4. Requires hdr=true and HDR access.
Per-signal conditioning controls (pose, depth, normals, trajectory, face) for finer control than edit_strength. Cannot be combined with auto_controls.
Multi-keyframe edit guide frames: up to 64 image URLs pinned at the source-frame positions given by keyframe_indexes. Mutually exclusive with start_image_url. Provide keyframes and keyframe_indexes together (same length).
Source-video frame positions where each keyframes[i] is anchored. Non-negative, unique, and the same length as keyframes.
enable_safety_checker booleanAuthorized callers may set false to request relaxed screening. Default value: true
{
"prompt": "Restyle the footage as a hand-painted watercolor animation with soft pastel colors.",
"video_url": "https://storage.googleapis.com/falserverless/example_inputs/birefnet-video-input.mp4",
"start_image_url": "https://storage.googleapis.com/falserverless/gallery/example_inputs_liuyifei.png",
"resolution": "540p",
"duration": "5s",
"enable_safety_checker": true
}The generated video.
The generated EXR sidecar when exr_export is true. This may be a single EXR file or a ZIP package depending on Luma's export shape.
{
"video": {
"url": "",
"content_type": "image/png",
"file_name": "z9RV14K95DvU.png",
"file_size": 4404019
}
}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.
Pose / skeleton conditioning.
Depth / scene-geometry conditioning.
Surface-normals conditioning.
Motion-trajectory conditioning.
Face-identity conditioning.
enabled booleanEnable pose / skeleton conditioning for the edit. Default value: true
strength EnumPose conditioning precision. 'precise' follows the source pose tightly; 'coarse' allows more freedom. Leave unset for the default.
Possible enum values: precise, coarse
enabled booleanEnable motion-trajectory conditioning for the edit. Default value: true
sparsity floatMotion-trajectory sparsity. Higher values use fewer motion anchors. Leave unset for the default.
enabled booleanEnable surface-normals conditioning for the edit. Default value: true
augmentation floatSurface-normals augmentation. Higher values allow more reinterpretation of surface geometry. Leave unset for the default.
enabled booleanEnable face-identity conditioning for the edit. Default value: true
enabled booleanEnable depth / scene-geometry conditioning for the edit. Default value: true
blur floatDepth blur. Higher values allow more geometric freedom. Leave unset for the default.