Try H3 Max Director
Log-inSign-up
Contact SalesLog-inSign-up

Bria AI logo
bria/ad-delayer

Convert a flat ad image into editable layers - background, product and logo cutouts, live text with typography, and vector shapes
Inference
Commercial use
Schema
LLMs
PlaygroundAPIExamples

Table of contents

About

Delayer

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("bria/ad-delayer", {
  input: {},
  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"
});

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("bria/ad-delayer", {
  input: {},
  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("bria/ad-delayer", {
  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("bria/ad-delayer", {
  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

Reference ad image to split into layers, as a public URL. Default value: "https://bria-datasets.s3.amazonaws.com/ad-delayer/aurora_ad.png"

text_mode TextModeEnum

Where the copy's glyphs come from. 'svg' traces them out of the reference ad as vector outlines, keeping the original letterforms; 'font' typesets them as live, editable text in the nearest matching font. Default value: "svg"

Possible enum values: svg, font

{
  "image_url": "https://bria-datasets.s3.amazonaws.com/ad-delayer/aurora_ad.png",
  "text_mode": "svg"
}

Output#

{}

Other types#

BBox#

x float* required

Left edge of the layer, in canvas pixels.

y float* required

Top edge of the layer, in canvas pixels.

width float* required

Layer width in canvas pixels.

height float* required

Layer height in canvas pixels.

Layer#

Canvas#

width integer* required

Ad canvas width in pixels.

height integer* required

Ad canvas height in pixels.