StatusDocsPricingCommunity
Log-inSign-up

Illusion Diffusion Text to Image

Illusion Diffusion
fal-ai/illusion-diffusion
Inference
Commercial use

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/illusion-diffusion", {
  input: {
    image_url: "https://storage.googleapis.com/falserverless/illusion-examples/pattern.png",
    prompt: "(masterpiece:1.4), (best quality), (detailed), Medieval village scene with busy streets and castle in the distance"
  },
  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/illusion-diffusion", {
  input: {
    image_url: "https://storage.googleapis.com/falserverless/illusion-examples/pattern.png",
    prompt: "(masterpiece:1.4), (best quality), (detailed), Medieval village scene with busy streets and castle in the distance"
  },
  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/illusion-diffusion", {
  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/illusion-diffusion", {
  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#

image_url string* required

Input image url.

prompt string* required

The prompt to use for generating the image. Be as descriptive as possible for best results.

negative_prompt string

The negative prompt to use. Use it to address details that you don't want in the image. This could be colors, objects, scenery and even the small details (e.g. moustache, blurry, low resolution). Default value: ""

guidance_scale float

The CFG (Classifier Free Guidance) scale is a measure of how close you want the model to stick to your prompt when looking for a related image to show you. Default value: 7.5

controlnet_conditioning_scale float

The scale of the ControlNet. Default value: 1

control_guidance_start float
control_guidance_end float

Default value: 1

seed integer

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.

scheduler SchedulerEnum

Scheduler / sampler to use for the image denoising process. Default value: "Euler"

Possible enum values: DPM++ Karras SDE, Euler

num_inference_steps integer

Increasing the amount of steps tells Stable Diffusion that it should take more steps to generate your final result which can increase the amount of detail in your image. Default value: 40

image_size ImageSize | Enum

The size of the generated image. You can choose between some presets or custom height and width that must be multiples of 8. Default value: square_hd

Possible enum values: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9

Note: For custom image sizes, you can pass the width and height as an object:

"image_size": {
  "width": 1280,
  "height": 720
}
{
  "image_url": "https://storage.googleapis.com/falserverless/illusion-examples/pattern.png",
  "prompt": "(masterpiece:1.4), (best quality), (detailed), Medieval village scene with busy streets and castle in the distance",
  "negative_prompt": "(worst quality, poor details:1.4), lowres, (artist name, signature, watermark:1.4), bad-artist-anime, bad_prompt_version2, bad-hands-5, ng_deepnegative_v1_75t",
  "guidance_scale": 7.5,
  "controlnet_conditioning_scale": 1,
  "control_guidance_end": 1,
  "scheduler": "Euler",
  "num_inference_steps": 40,
  "image_size": "square_hd"
}

Output#

image Image* required

The generated image file info.

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.

{
  "image": {
    "url": "https://url.to/generated/file/z9RV14K95DvU.png",
    "content_type": "image/png",
    "file_name": "z9RV14K95DvU.png",
    "file_size": 4404019,
    "width": 1024,
    "height": 1024
  }
}

Other types#

Image#

url string* required

The URL where the file can be downloaded from.

content_type string* required

The mime type of the file.

file_name string* required

The name of the file. It will be auto-generated if not provided.

file_size integer* required

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.

ImageSize#

width integer

The width of the generated image. Default value: 512

height integer

The height of the generated image. Default value: 512