Run models all in one Sandbox 🏖️
Docs
Log-inSign-up

fal-ai/joyai-image-edit

All-in-one image AI with JoyAI-Image. Understand, create, and edit images through natural language—the model's deep visual understanding powers more accurate generation and precise editing in a unified system.
Inference
Commercial use
Schema
LLMs
PlaygroundAPIExamples

Table of contents

About

Generate

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/joyai-image-edit", {
  input: {
    prompt: "Add a red hat to the dog",
    image_url: "https://storage.googleapis.com/falserverless/example_inputs/dog.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"
});

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/joyai-image-edit", {
  input: {
    prompt: "Add a red hat to the dog",
    image_url: "https://storage.googleapis.com/falserverless/example_inputs/dog.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/joyai-image-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("fal-ai/joyai-image-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);

Read more about file handling in our file upload guide.

5. Schema#

Input#

prompt string* required

The edit instruction describing what changes to make to the image.

image_url string* required

URL of the input image to edit.

negative_prompt string

Text describing what should not appear in the output image. Default value: ""

seed integer

Random seed for reproducibility.

num_inference_steps integer

Number of denoising steps. Default value: 30

guidance_scale float

Controls how closely the output follows the edit instruction. Default value: 5

enable_safety_checker boolean

Enable safety checking on input and output. Default value: true

output_format OutputFormatEnum

Output image format. Default value: "jpeg"

Possible enum values: jpeg, png

sync_mode boolean

If True, return image as data URI.

{
  "prompt": "Add a red hat to the dog",
  "image_url": "https://storage.googleapis.com/falserverless/example_inputs/dog.png",
  "num_inference_steps": 30,
  "guidance_scale": 5,
  "enable_safety_checker": true,
  "output_format": "jpeg"
}

Output#

images list<Image>* required

The edited output image.

timings Timings* required
seed integer* required

Seed of the generated Image. It will be the same value of the one passed in the input or the randomly generated that was used in case none was passed.

has_nsfw_concepts list<boolean>* required

Whether the generated images contain NSFW concepts.

prompt string* required

The prompt used for generating the image.

{
  "images": [
    {
      "width": 1024,
      "url": "https://v3b.fal.media/files/b/0a951738/yWOL7Oie3FQfzM9_HD5BJ.jpg",
      "content_type": "image/jpeg",
      "height": 1024
    }
  ],
  "prompt": ""
}

Other types#

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.

width integer

The width of the image in pixels.

height integer

The height of the image in pixels.