fal Sandbox is here - run all your models together! 🏖️
DocsBlogPricingEnterpriseCareersResearch Grants
Log-inSign-up

Emu 3.5 Image Image to Image

fal-ai/emu-3.5-image/edit-image
Edit images with a text prompt using Emu 3.5 Image
Inference
Commercial use
Streaming
Schema
LLMs
PlaygroundAPI

About

Edit an image based on a text description using Emu3.5 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

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/emu-3.5-image/edit-image", {
  input: {
    prompt: "Recreate this image in ukiyo-e style",
    image_url: "https://v3b.fal.media/files/b/lion/iC4LKAESSVo4ug-XzmR11_e9cafdab-c8b4-4267-804e-230e3d0d0814.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);

Streaming#

This model supports streaming requests. You can stream data directly to the model and get the result in real-time.

import { fal } from "@fal-ai/client";

const stream = await fal.stream("fal-ai/emu-3.5-image/edit-image", {
  input: {
    prompt: "Recreate this image in ukiyo-e style",
    image_url: "https://v3b.fal.media/files/b/lion/iC4LKAESSVo4ug-XzmR11_e9cafdab-c8b4-4267-804e-230e3d0d0814.png"
  }
});

for await (const event of stream) {
  console.log(event);
}

const result = await stream.done();

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/emu-3.5-image/edit-image", {
  input: {
    prompt: "Recreate this image in ukiyo-e style",
    image_url: "https://v3b.fal.media/files/b/lion/iC4LKAESSVo4ug-XzmR11_e9cafdab-c8b4-4267-804e-230e3d0d0814.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/emu-3.5-image/edit-image", {
  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/emu-3.5-image/edit-image", {
  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#

prompt string* required

The prompt to edit the image.

resolution ResolutionEnum

The resolution of the output image. Default value: "720p"

Possible enum values: 480p, 720p

aspect_ratio AspectRatioEnum

The aspect ratio of the output image. Default value: "auto"

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

enable_safety_checker boolean

Whether to enable the safety checker. Default value: true

seed integer

The seed for the inference.

output_format OutputFormatEnum

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

Possible enum values: jpeg, png, webp

sync_mode boolean

Whether to return the image in sync mode.

image_url string* required

The image to edit.

{
  "prompt": "Recreate this image in ukiyo-e style",
  "resolution": "720p",
  "aspect_ratio": "auto",
  "enable_safety_checker": true,
  "output_format": "png",
  "image_url": "https://v3b.fal.media/files/b/lion/iC4LKAESSVo4ug-XzmR11_e9cafdab-c8b4-4267-804e-230e3d0d0814.png"
}

Output#

images list<ImageFile>* required

The edited image.

seed integer* required

The seed for the inference.

{
  "images": [
    {
      "height": 1168,
      "file_name": "t4nYWb1Zk7Uc6x2nSLysb.jpg",
      "content_type": "image/jpeg",
      "url": "https://v3b.fal.media/files/b/monkey/t4nYWb1Zk7Uc6x2nSLysb.jpg",
      "width": 784
    }
  ],
  "seed": 1021074961
}

Other types#

ImageFile#

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

height integer

The height of the image

Related Models