Kling O1 Image: Multi-Reference AI Image Editor

fal-ai/kling-image/o1

Perform precise image edits using strong reference control, transforming subjects, styles, and local details while preserving visual consistency.

Inference

Commercial use

Partner

Schema

LLMs

Playground API

About

Generate images using Kling O1 model.

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/kling-image/o1", {
  input: {
    prompt: "Put @Image1 to the back seat of the car in @Image2, put @Element1 on to the @Image1",
    image_urls: ["https://storage.googleapis.com/falserverless/example_inputs/kling-image-o1/input.png", "https://storage.googleapis.com/falserverless/example_inputs/kling-image-o1/input-2.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("fal-ai/kling-image/o1", {
  input: {
    prompt: "Put @Image1 to the back seat of the car in @Image2, put @Element1 on to the @Image1",
    image_urls: ["https://storage.googleapis.com/falserverless/example_inputs/kling-image-o1/input.png", "https://storage.googleapis.com/falserverless/example_inputs/kling-image-o1/input-2.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("fal-ai/kling-image/o1", {
  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/kling-image/o1", {
  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 for image generation. Reference images using @Image1, @Image2, etc. (or @Image if only one image). Max 2500 characters.

image_urls list<string>* required

List of reference images. Reference images in prompt using @Image1, @Image2, etc. (1-indexed). Max 10 images.

elements list<ElementInput>

Elements (characters/objects) to include in the image. Reference in prompt as @Element1, @Element2, etc. Maximum 10 total (elements + reference images).

resolution ResolutionEnum

Image generation resolution. 1K: standard, 2K: high-res. Default value: "1K"

Possible enum values: 1K, 2K

num_images integer

Number of images to generate (1-9). Default value: 1

aspect_ratio AspectRatioEnum

Aspect ratio of generated images. 'auto' intelligently determines based on input content. Default value: "auto"

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

output_format OutputFormatEnum

The format of the generated image. Default value: "png"

Possible enum values: jpeg, png, webp

sync_mode boolean

If True, the media will be returned as a data URI and the output data won't be available in the request history.

{
  "prompt": "Put @Image1 to the back seat of the car in @Image2, put @Element1 on to the @Image1",
  "image_urls": [
    "https://storage.googleapis.com/falserverless/example_inputs/kling-image-o1/input.png",
    "https://storage.googleapis.com/falserverless/example_inputs/kling-image-o1/input-2.png"
  ],
  "elements": [
    {
      "reference_image_urls": [
        "https://storage.googleapis.com/falserverless/example_inputs/kling-image-o1/element-1-reference.png"
      ],
      "frontal_image_url": "https://storage.googleapis.com/falserverless/example_inputs/kling-image-o1/element-1-front.png"
    }
  ],
  "resolution": "1K",
  "num_images": 1,
  "aspect_ratio": "auto",
  "output_format": "png"
}

Output#

images list<Image>* required

Generated images

{
  "images": [
    {
      "file_size": 1419818,
      "file_name": "d4eeaeaeae294a41b0321ba6c99f0f9d.png",
      "content_type": "image/png",
      "url": "https://storage.googleapis.com/falserverless/example_outputs/kling-image-o1/output.png"
    }
  ]
}

Other types#

O3TextToImageRequest#

prompt string* required

Text prompt for image generation. Max 2500 characters.

elements list<ElementInput>

Optional: Elements (characters/objects) for face control. Reference in prompt as @Element1, @Element2, etc.

resolution ResolutionEnum

Image generation resolution. 1K: standard, 2K: high-res, 4K: ultra high-res. Default value: "1K"

Possible enum values: 1K, 2K, 4K

result_type ResultTypeEnum

Result type. 'single' for one image, 'series' for a series of related images. Default value: "single"

Possible enum values: single, series

num_images integer

Number of images to generate (1-9). Only used when result_type is 'single'. Default value: 1

series_amount integer

Number of images in series (2-9). Only used when result_type is 'series'.

aspect_ratio AspectRatioEnum

Aspect ratio of generated images. Default value: "16:9"

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

output_format OutputFormatEnum

The format of the generated image. Default value: "png"

Possible enum values: jpeg, png, webp

sync_mode boolean

If True, the media will be returned as a data URI.

V3ImageToImageRequest#

prompt string* required

Text prompt for image generation. Max 2500 characters.

image_url string* required

Reference image for image-to-image generation.

elements list<ElementInput>

Optional: Elements (characters/objects) to include in the image for face control.

resolution ResolutionEnum

Image generation resolution. 1K: standard, 2K: high-res. Default value: "1K"

Possible enum values: 1K, 2K

num_images integer

Number of images to generate (1-9). Default value: 1

aspect_ratio AspectRatioEnum

Aspect ratio of generated images. Default value: "16:9"

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

output_format OutputFormatEnum

The format of the generated image. Default value: "png"

Possible enum values: jpeg, png, webp

sync_mode boolean

If True, the media will be returned as a data URI.

O3ImageToImageRequest#

prompt string* required

Text prompt for image generation. Reference images using @Image1, @Image2, etc. (or @Image if only one image). Max 2500 characters.

image_urls list<string>* required

List of reference images. Reference images in prompt using @Image1, @Image2, etc. (1-indexed). Max 10 images.

elements list<ElementInput>

Optional: Elements (characters/objects) for face control. Reference in prompt as @Element1, @Element2, etc.

resolution ResolutionEnum

Image generation resolution. 1K: standard, 2K: high-res, 4K: ultra high-res. Default value: "1K"

Possible enum values: 1K, 2K, 4K

result_type ResultTypeEnum

Result type. 'single' for one image, 'series' for a series of related images. Default value: "single"

Possible enum values: single, series

num_images integer

Number of images to generate (1-9). Only used when result_type is 'single'. Default value: 1

series_amount integer

Number of images in series (2-9). Only used when result_type is 'series'.

aspect_ratio AspectRatioEnum

Aspect ratio of generated images. 'auto' intelligently determines based on input content. Default value: "auto"

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

output_format OutputFormatEnum

The format of the generated image. Default value: "png"

Possible enum values: jpeg, png, webp

sync_mode boolean

If True, the media will be returned as a data URI.

Image#

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

width integer

The width of the image in pixels.

height integer

The height of the image in pixels.

V3TextToImageRequest#

prompt string* required

Text prompt for image generation. Max 2500 characters.

negative_prompt string

Negative text prompt. It is recommended to supplement negative prompt information through negative sentences directly within positive prompts.

elements list<ElementInput>

Optional: Elements (characters/objects) to include in the image for face control. Each element can have a frontal image and optionally reference images.

resolution ResolutionEnum

Image generation resolution. 1K: standard, 2K: high-res. Default value: "1K"

Possible enum values: 1K, 2K

num_images integer

Number of images to generate (1-9). Default value: 1

aspect_ratio AspectRatioEnum

Aspect ratio of generated images. Default value: "16:9"

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

output_format OutputFormatEnum

The format of the generated image. Default value: "png"

Possible enum values: jpeg, png, webp

sync_mode boolean

If True, the media will be returned as a data URI.

Kling O1 Image Image to Image

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#

O3TextToImageRequest#

V3ImageToImageRequest#

O3ImageToImageRequest#

Image#

V3TextToImageRequest#