The @fal-ai/serverless-client package has been deprecated in favor of @fal-ai/client. Install the new package and update your imports — see client setup.

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/dreamo", {
  input: {
    prompt: "Two people hugging inside a forest"
  },
  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 an environment where you cannot set environment variables, you can configure the API key manually on the client.

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/dreamo", {
  input: {
    prompt: "Two people hugging inside a forest"
  },
  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/dreamo", {
  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/dreamo", {
  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

The prompt to generate an image from.

first_image_url string

URL of first reference image to use for generation.

second_image_url string

URL of second reference image to use for generation.

first_reference_task FirstReferenceTaskEnum

Task for first reference image (ip/id/style). Default value: "ip"

Possible enum values: ip, id, style

second_reference_task SecondReferenceTaskEnum

Task for second reference image (ip/id/style). Default value: "ip"

Possible enum values: ip, id, style

image_size ImageSize | Enum

The size of the generated image. 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
}

num_inference_steps integer

The number of inference steps to perform. Default value: 12

seed integer

The same seed and the same prompt given to the same version of the model will output the same image every time.

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: 3.5

negative_prompt string

The prompt to generate an image from. Default value: ""

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.

ref_resolution integer

Resolution for reference images. Default value: 512

true_cfg float

The weight of the CFG loss. Default value: 1

enable_safety_checker boolean

If set to true, the safety checker will be enabled. Disabling it requires account authorization; unauthorized requests are always checked, and images flagged as unsafe are returned as black images. Default value: true

{
  "prompt": "Two people hugging inside a forest",
  "first_image_url": "https://v3.fal.media/files/rabbit/I3exImt_zOYaiZv8caeGP_Pz4CnQ12tCUuDIhEQkmbD_ae4193792924495e89c516e6b492ed2b_1.jpg",
  "second_image_url": "https://v3.fal.media/files/penguin/F3Yqprwlv-yaeusxAS0bS_image.webp",
  "first_reference_task": "ip",
  "second_reference_task": "ip",
  "image_size": "square_hd",
  "num_inference_steps": 12,
  "guidance_scale": 3.5,
  "negative_prompt": "bad quality, worst quality, text, signature, watermark, extra limbs",
  "ref_resolution": 512,
  "true_cfg": 1,
  "enable_safety_checker": true
}

Output#

images list<Image>* required

The URLs of the generated images.

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 to generate the image.

{
  "images": [
    {
      "content_type": "image/jpeg",
      "height": 1024,
      "width": 1024,
      "url": "https://v3.fal.media/files/elephant/Qqd29dv20375fBbN1233_.png"
    }
  ],
  "prompt": "Two people hugging inside a forest"
}

Other types#

ImageSize#

width integer

The width of the generated image. Default value: 512

height integer

The height of the generated image. Default value: 512

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.

Loading API documentation…

1. Calling the API

2. Authentication

API Key

3. Queue

4. Files

5. Schema

This endpoint is deprecated

This model is no longer supported.

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

Migrate to @fal-ai/client

The @fal-ai/serverless-client package has been deprecated in favor of @fal-ai/client. Install the new package and update your imports — see client setup.

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/dreamo", {
  input: {
    prompt: "Two people hugging inside a forest"
  },
  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 an environment where you cannot set environment variables, you can configure the API key manually on the client.

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

fal.config({
  credentials: "YOUR_FAL_KEY"
});

Protect your API Key

3. Queue#

Long-running requests

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/dreamo", {
  input: {
    prompt: "Two people hugging inside a forest"
  },
  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/dreamo", {
  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/dreamo", {
  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)#

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

The prompt to generate an image from.

first_image_url string

URL of first reference image to use for generation.

second_image_url string

URL of second reference image to use for generation.

first_reference_task FirstReferenceTaskEnum

Task for first reference image (ip/id/style). Default value: "ip"

Possible enum values: ip, id, style

second_reference_task SecondReferenceTaskEnum

Task for second reference image (ip/id/style). Default value: "ip"

Possible enum values: ip, id, style

image_size ImageSize | Enum

The size of the generated image. 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
}

num_inference_steps integer

The number of inference steps to perform. Default value: 12

seed integer

The same seed and the same prompt given to the same version of the model will output the same image every time.

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: 3.5

negative_prompt string

The prompt to generate an image from. Default value: ""

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.

ref_resolution integer

Resolution for reference images. Default value: 512

true_cfg float

The weight of the CFG loss. Default value: 1

enable_safety_checker boolean

{
  "prompt": "Two people hugging inside a forest",
  "first_image_url": "https://v3.fal.media/files/rabbit/I3exImt_zOYaiZv8caeGP_Pz4CnQ12tCUuDIhEQkmbD_ae4193792924495e89c516e6b492ed2b_1.jpg",
  "second_image_url": "https://v3.fal.media/files/penguin/F3Yqprwlv-yaeusxAS0bS_image.webp",
  "first_reference_task": "ip",
  "second_reference_task": "ip",
  "image_size": "square_hd",
  "num_inference_steps": 12,
  "guidance_scale": 3.5,
  "negative_prompt": "bad quality, worst quality, text, signature, watermark, extra limbs",
  "ref_resolution": 512,
  "true_cfg": 1,
  "enable_safety_checker": true
}

Output#

images list<Image>* required

The URLs of the generated images.

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 to generate the image.

{
  "images": [
    {
      "content_type": "image/jpeg",
      "height": 1024,
      "width": 1024,
      "url": "https://v3.fal.media/files/elephant/Qqd29dv20375fBbN1233_.png"
    }
  ],
  "prompt": "Two people hugging inside a forest"
}

Other types#

ImageSize#

width integer

The width of the generated image. Default value: 512

height integer

The height of the generated image. Default value: 512

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.

fal-ai/dreamo

This endpoint is deprecated

fal-ai/dreamo

This endpoint is deprecated

Table of contents

1. Calling the API

2. Authentication

3. Queue

4. Files

5. Schema

This endpoint is deprecated

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#

ImageSize#

Image#

Table of contents

1. Calling the API

2. Authentication

3. Queue

4. Files

5. Schema

This endpoint is deprecated

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#

ImageSize#

Image#