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/ideogram/v3/layerize-text", {
  input: {
    image_url: "https://v3.fal.media/files/lion/0qJs_qW8nz0wYsXhFa6Tk.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 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/ideogram/v3/layerize-text", {
  input: {
    image_url: "https://v3.fal.media/files/lion/0qJs_qW8nz0wYsXhFa6Tk.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/ideogram/v3/layerize-text", {
  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/ideogram/v3/layerize-text", {
  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#

image_url string* required

URL of the flat graphic image to layerize. Must be JPEG, PNG, or WebP (max 10MB).

prompt string

Optional prompt to guide the layerization.

seed integer

Seed for the random number generator.

font_file_h1_url string

URL of the font file to use for h1 text. Cannot be used with font_name_h1.

font_name_h1 string

Name of the font to use for h1 text. Cannot be used with font_file_h1_url.

font_file_h2_url string

URL of the font file to use for h2 text. Cannot be used with font_name_h2.

font_name_h2 string

Name of the font to use for h2 text. Cannot be used with font_file_h2_url.

font_file_body_url string

URL of the font file to use for body text. Cannot be used with font_name_body.

font_name_body string

Name of the font to use for body text. Cannot be used with font_file_body_url.

font_file_small_url string

URL of the font file to use for small text. Cannot be used with font_name_small.

font_name_small string

Name of the font to use for small text. Cannot be used with font_file_small_url.

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.

{
  "image_url": "https://v3.fal.media/files/lion/0qJs_qW8nz0wYsXhFa6Tk.png"
}

Output#

image File* required

The background image with text removed.

prompt string* required

The prompt used for layerization. May differ from the input prompt if MagicPrompt expanded it.

text_containers list<object>

Structured text containers with hierarchical text data (container -> items -> spans).

text_html string

Rendered overlay HTML for compositing text over the background image.

image_layers list<object>

Image layers extracted from the design.

seed integer* required

Seed used for the random number generator.

{
  "image": {
    "url": "",
    "content_type": "image/png",
    "file_name": "z9RV14K95DvU.png",
    "file_size": 4404019
  },
  "prompt": "",
  "seed": 123456
}

Other types#

File#

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.

Loading API documentation…

1. Calling the API

2. Authentication

API Key

3. Queue

4. Files

5. Schema

About

Ideogram V3 Layerize

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/ideogram/v3/layerize-text", {
  input: {
    image_url: "https://v3.fal.media/files/lion/0qJs_qW8nz0wYsXhFa6Tk.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 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/ideogram/v3/layerize-text", {
  input: {
    image_url: "https://v3.fal.media/files/lion/0qJs_qW8nz0wYsXhFa6Tk.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/ideogram/v3/layerize-text", {
  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/ideogram/v3/layerize-text", {
  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#

image_url string* required

URL of the flat graphic image to layerize. Must be JPEG, PNG, or WebP (max 10MB).

prompt string

Optional prompt to guide the layerization.

seed integer

Seed for the random number generator.

font_file_h1_url string

URL of the font file to use for h1 text. Cannot be used with font_name_h1.

font_name_h1 string

Name of the font to use for h1 text. Cannot be used with font_file_h1_url.

font_file_h2_url string

URL of the font file to use for h2 text. Cannot be used with font_name_h2.

font_name_h2 string

Name of the font to use for h2 text. Cannot be used with font_file_h2_url.

font_file_body_url string

URL of the font file to use for body text. Cannot be used with font_name_body.

font_name_body string

Name of the font to use for body text. Cannot be used with font_file_body_url.

font_file_small_url string

URL of the font file to use for small text. Cannot be used with font_name_small.

font_name_small string

Name of the font to use for small text. Cannot be used with font_file_small_url.

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.

{
  "image_url": "https://v3.fal.media/files/lion/0qJs_qW8nz0wYsXhFa6Tk.png"
}

Output#

image File* required

The background image with text removed.

prompt string* required

The prompt used for layerization. May differ from the input prompt if MagicPrompt expanded it.

text_containers list<object>

Structured text containers with hierarchical text data (container -> items -> spans).

text_html string

Rendered overlay HTML for compositing text over the background image.

image_layers list<object>

Image layers extracted from the design.

seed integer* required

Seed used for the random number generator.

{
  "image": {
    "url": "",
    "content_type": "image/png",
    "file_name": "z9RV14K95DvU.png",
    "file_size": 4404019
  },
  "prompt": "",
  "seed": 123456
}

Other types#

File#

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.

fal-ai/ideogram/v3/layerize-text

fal-ai/ideogram/v3/layerize-text

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#

File#

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#

File#