luma/agent/uni-1/v1/edit

Luma Uni-1 Edit reworks a source image from a text instruction, preserving the original composition while applying style changes and following optional reference images to steer the result.

Inference

Commercial use

Partner

Schema

LLMs

Playground API Examples

About

Edit Image

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("luma/agent/uni-1/v1/edit", {
  input: {
    prompt: "Replace the background with a sunset over the ocean.",
    image_url: "https://storage.googleapis.com/falserverless/gallery/example_inputs_liuyifei.png"
  },
  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("luma/agent/uni-1/v1/edit", {
  input: {
    prompt: "Replace the background with a sunset over the ocean.",
    image_url: "https://storage.googleapis.com/falserverless/gallery/example_inputs_liuyifei.png"
  },
  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("luma/agent/uni-1/v1/edit", {
  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("luma/agent/uni-1/v1/edit", {
  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* required

Text prompt describing the edit to apply.

image_url string* required

URL of the source image to edit.

style StyleEnum

Visual style of the edited image. Default value: "auto"

Possible enum values: auto, manga

output_format Enum

Encoding format of the edited image.

Possible enum values: png, jpeg

reference_image_urls list<string>

Optional list of reference image URLs used to guide the edit.

{
  "prompt": "Replace the background with a sunset over the ocean.",
  "image_url": "https://storage.googleapis.com/falserverless/gallery/example_inputs_liuyifei.png",
  "style": "auto"
}

Output#

images list<File>* required

The generated image(s).

{
  "images": [
    {
      "url": "",
      "content_type": "image/png",
      "file_name": "z9RV14K95DvU.png",
      "file_size": 4404019
    }
  ]
}

Other types#

RayEditFaceControl#

enabled boolean

Enable face-identity conditioning for the edit. Default value: true

RayEditNormalsControl#

enabled boolean

Enable surface-normals conditioning for the edit. Default value: true

augmentation float

Surface-normals augmentation. Higher values allow more reinterpretation of surface geometry. Leave unset for the default.

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.

RayImageToVideoRequest#

prompt string* required

Text prompt describing the motion/scene to generate.

image_url string

URL of the image used as the first frame of the video. Provide either image_url (optionally with end_image_url) or keyframes — the two anchoring modes are mutually exclusive.

end_image_url string

Optional URL of an image used as the last frame. When set, the model interpolates between image_url and end_image_url. Cannot be combined with keyframes.

aspect_ratio AspectRatioEnum

Aspect ratio of the generated video. Default value: "16:9"

Possible enum values: 3:4, 4:3, 1:1, 9:16, 16:9, 21:9

resolution ResolutionEnum

Resolution of the generated video. Higher resolutions cost more. Default value: "540p"

Possible enum values: 540p, 720p, 1080p

duration DurationEnum

Duration of the generated video. 10s requires multi-keyframe input (keyframes / keyframe_indexes); it is not supported with a single image_url / end_image_url anchor. Default value: "5s"

Possible enum values: 5s, 10s

loop boolean

Generate a seamless loop. Only valid for standard-dynamic-range generations without an end frame or keyframes.

hdr boolean

Generate an HDR-encoded MP4. Requires HDR access on the account and a resolution of 720p or 1080p; not supported with loop.

exr_export boolean

Also export an EXR file alongside the MP4. Requires hdr=true and HDR access.

keyframes list<string>

Multi-keyframe image-to-video guide frames: 1-64 image URLs pinned at the positions given by keyframe_indexes. Mutually exclusive with image_url, end_image_url, and loop; unlocks 10s and HDR. Provide keyframes and keyframe_indexes together (same length).

keyframe_indexes list<integer>

Output-frame positions (duration x 24fps: 5s -> 0-120, 10s -> 0-240) where each keyframes[i] is anchored. Non-negative, unique, and the same length as keyframes.

RayReframeRequest#

prompt string* required

Text prompt describing the content to paint into the newly exposed canvas area when reframing to the target aspect ratio.

video_url string* required

URL of the source video to reframe (must be 30 seconds or less).

aspect_ratio AspectRatioEnum* required

Target aspect ratio for the reframed video.

Possible enum values: 3:4, 4:3, 1:1, 9:16, 16:9, 21:9

resolution ResolutionEnum

Resolution of the reframed video. Higher resolutions cost more. Default value: "540p"

Possible enum values: 540p, 720p, 1080p

source_position RayReframeSourcePosition

Optional normalized source rectangle controlling where the source video sits in the output canvas.

RayEditTrajectoryControl#

enabled boolean

Enable motion-trajectory conditioning for the edit. Default value: true

sparsity float

Motion-trajectory sparsity. Higher values use fewer motion anchors. Leave unset for the default.

RayEditDepthControl#

enabled boolean

Enable depth / scene-geometry conditioning for the edit. Default value: true

blur float

Depth blur. Higher values allow more geometric freedom. Leave unset for the default.

RayEditControls#

pose RayEditPoseControl

Pose / skeleton conditioning.

depth RayEditDepthControl

Depth / scene-geometry conditioning.

normals RayEditNormalsControl

Surface-normals conditioning.

trajectory RayEditTrajectoryControl

Motion-trajectory conditioning.

face RayEditFaceControl

Face-identity conditioning.

RayReframeSourcePosition#

x_norm float* required

Left edge of the source rectangle as a fraction of output width.

y_norm float* required

Top edge of the source rectangle as a fraction of output height.

w_norm float* required

Width of the source rectangle as a fraction of output width.

h_norm float* required

Height of the source rectangle as a fraction of output height.

RayVideoToVideoRequest#

prompt string* required

Text prompt describing how to edit the source video.

video_url string* required

URL of the source video to edit.

start_image_url string

Optional 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 ResolutionEnum

Resolution of the edited video. Higher resolutions cost more. Default value: "540p"

Possible enum values: 540p, 720p, 1080p

duration DurationEnum

Duration of the edited video. Default value: "5s"

Possible enum values: 5s, 10s

edit_strength Enum

How 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 boolean

Let the model derive the edit conditioning schedule from the source video. Cannot be combined with edit_strength.

hdr boolean

Generate an HDR-encoded MP4. Requires HDR access on the account and a resolution of 720p or 1080p.

exr_export boolean

Also export an EXR file alongside the MP4. Requires hdr=true and HDR access.

controls RayEditControls

Per-signal conditioning controls (pose, depth, normals, trajectory, face) for finer control than edit_strength. Cannot be combined with auto_controls.

keyframes list<string>

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).

keyframe_indexes list<integer>

Source-video frame positions where each keyframes[i] is anchored. Non-negative, unique, and the same length as keyframes.

RayEditPoseControl#

enabled boolean

Enable pose / skeleton conditioning for the edit. Default value: true

strength Enum

Pose conditioning precision. 'precise' follows the source pose tightly; 'coarse' allows more freedom. Leave unset for the default.

Possible enum values: precise, coarse

TextToImageRequest#

prompt string* required

Text prompt describing the image to generate.

aspect_ratio Enum

Aspect ratio of the generated image.

Possible enum values: 3:1, 2:1, 16:9, 3:2, 1:1, 2:3, 9:16, 1:2, 1:3

style StyleEnum

Visual style of the generated image. Default value: "auto"

Possible enum values: auto, manga

output_format Enum

Encoding format of the generated image.

Possible enum values: png, jpeg

enable_web_search boolean

When true, the model may consult the web for references.

reference_image_urls list<string>

Optional list of reference image URLs used to guide the generation.

RayTextToVideoRequest#

prompt string* required

Text prompt describing the video to generate.

aspect_ratio AspectRatioEnum

Aspect ratio of the generated video. Default value: "16:9"

Possible enum values: 3:4, 4:3, 1:1, 9:16, 16:9, 21:9

resolution ResolutionEnum

Resolution of the generated video. Higher resolutions cost more. Default value: "540p"

Possible enum values: 540p, 720p, 1080p

duration DurationEnum

Duration of the generated video. Default value: "5s"

Possible enum values: 5s, 10s

loop boolean

Generate a seamless loop. Only valid for 5s, standard-dynamic-range generations without an end frame.

hdr boolean

Generate an HDR-encoded MP4. Requires HDR access on the account and a resolution of 720p or 1080p; not supported with 10s or loop.

exr_export boolean

Also export an EXR file alongside the MP4. Requires hdr=true and HDR access.

luma/agent/uni-1/v1/edit

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#

RayEditFaceControl#

RayEditNormalsControl#

File#

RayImageToVideoRequest#

RayReframeRequest#

RayEditTrajectoryControl#

RayEditDepthControl#

RayEditControls#

RayReframeSourcePosition#

RayVideoToVideoRequest#

RayEditPoseControl#

TextToImageRequest#

RayTextToVideoRequest#

Related Models