Decompose an image with Bytedance's Seedream 5.0 Flash model.
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/clientThe @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.
Set FAL_KEY as an environment variable in your runtime.
export FAL_KEY="YOUR_API_KEY"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("bytedance/seedream/v5/flash/layerize", {
input: {
image_url: "https://storage.googleapis.com/falserverless/example_inputs/kontext_example_input.webp"
},
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);The API uses an API Key for authentication. It is recommended you set the FAL_KEY environment variable in your runtime when possible.
import { fal } from "@fal-ai/client";
fal.config({
credentials: "YOUR_FAL_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.
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("bytedance/seedream/v5/flash/layerize", {
input: {
image_url: "https://storage.googleapis.com/falserverless/example_inputs/kontext_example_input.webp"
},
webhookUrl: "https://optional.webhook.url/for/results",
});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("bytedance/seedream/v5/flash/layerize", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b",
logs: true,
});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("bytedance/seedream/v5/flash/layerize", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});
console.log(result.data);
console.log(result.requestId);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.
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.
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.
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);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.
prompt stringOptional instructions describing which elements to separate. When empty, the model automatically separates the major elements. Normalized <bbox>left top right bottom</bbox> tags may be used for precise coordinate targeting. Default value: ""
image_url string* requiredURL of the image to decompose into a base image and independently editable layers. The image must contain between 512x512 and 6000x6000 total pixels, have an aspect ratio between 1/16 and 16, and be no larger than 30 MB.
image_size ImageSizeEnumResolution tier for the output base image and layers. auto adapts to the input image while preserving each element's aspect ratio. Default value: "auto"
Possible enum values: auto, auto_1K, auto_1.5K, auto_2K
sync_mode booleanIf True, the media will be returned as a data URI and the output data won't be available in the request history.
enable_safety_checker booleanIf set to true, the safety checker will be enabled. Disabling it requires account authorization; unauthorized requests are always checked. Default value: true
{
"prompt": "Return name and description in english.",
"image_url": "https://storage.googleapis.com/falserverless/example_inputs/kontext_example_input.webp",
"image_size": "auto",
"enable_safety_checker": true
}The same images as layers, in the same order, flattened for gallery rendering.
The base image followed by up to 16 separated layers, ordered by increasing z_index.
{
"images": [
{
"url": "https://v3b.fal.media/files/b/0aa54c02/95ZvKubW63JnC9ubRbDo2_74290e95fb6d4bd4bac756f3e2667317.png"
}
],
"layers": [
{
"image": {
"url": "",
"content_type": "image/png",
"file_name": "z9RV14K95DvU.png",
"file_size": 4404019,
"width": 1024,
"height": 1024
}
}
]
}The generated base image or separated layer.
z_index integer* requiredStacking order from bottom to top. The base image always has z_index 0.
The layer's position in the base image coordinate system. Omitted for the base image.
name stringModel-generated label for the layer. Omitted for the base image.
description stringDetailed model-generated description of the layer. Omitted for the base image.
url string* requiredThe URL where the file can be downloaded from.
content_type stringThe mime type of the file.
file_name stringThe name of the file. It will be auto-generated if not provided.
file_size integerThe size of the file in bytes.
width integerThe width of the image in pixels.
height integerThe height of the image in pixels.
Layer bounds as [left, top, right, bottom] pixel coordinates in the output base image coordinate system.
Layer bounds as [left, top, right, bottom] coordinates normalized to the integer range [0, 1000].