Loading API documentation
Convert To Pixel
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("fal-ai/image2pixel", {
input: {
image_url: "https://storage.googleapis.com/falserverless/example_inputs/image2pixel-input.jpg"
},
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("fal-ai/image2pixel", {
input: {
image_url: "https://storage.googleapis.com/falserverless/example_inputs/image2pixel-input.jpg"
},
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("fal-ai/image2pixel", {
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("fal-ai/image2pixel", {
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.
image_url string* requiredThe image URL to process into improved pixel art
max_colors integerMaximum number of colors in the output palette. Set None to disable limit. Default value: 32
auto_color_detect booleanEnable automatic detection of optimal number of colors.
Optional fixed color palette as hex strings (e.g., ['#000000', '#ffffff']).
detect_method DetectMethodEnumScale detection method to use. Default value: "auto"
Possible enum values: auto, runs, edge
scale integerForce a specific pixel scale. If None, auto-detect.
downscale_method DownscaleMethodEnumDownscaling method to produce the pixel-art output. Default value: "dominant"
Possible enum values: dominant, median, mode, mean, content-adaptive
trim_borders booleanTrim borders of the image.
transparent_background booleanRemove background of the image. This will check for contiguous color regions from the edges after correction and make them transparent.
cleanup_morph booleanApply morphological operations to remove noise.
cleanup_jaggy booleanRemove isolated diagonal pixels (jaggy edge cleanup).
snap_grid booleanAlign output to the pixel grid. Default value: true
alpha_threshold integerAlpha binarization threshold (0-255). Default value: 128
dominant_color_threshold floatDominant color threshold (0.0-1.0). Default value: 0.05
background_tolerance integerBackground tolerance (0-255).
background_mode BackgroundModeEnumControls where to flood-fill from when removing the background. Default value: "corners"
Possible enum values: edges, corners, midpoints
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.
{
"image_url": "https://storage.googleapis.com/falserverless/example_inputs/image2pixel-input.jpg",
"max_colors": 32,
"detect_method": "auto",
"downscale_method": "dominant",
"snap_grid": true,
"alpha_threshold": 128,
"dominant_color_threshold": 0.05,
"background_mode": "corners"
}pixel_scale integer* requiredThe detected pixel scale of the input.
The palette of the processed media.
num_colors integer* requiredThe number of colors in the processed media.
The processed pixel-art image (PNG) and the scaled image (PNG).
{
"pixel_scale": 21,
"palette": [
"#000000",
"#252524",
"#282826",
"#2b2b2a",
"#323232",
"#4c4c4c",
"#d57322",
"#dbdbdc",
"#f6922b",
"#fefefe"
],
"num_colors": 10,
"images": [
{
"height": 1008,
"content_type": "image/png",
"width": 1008,
"url": "https://storage.googleapis.com/falserverless/example_outputs/image2pixel-output.png",
"file_name": "image2pixel-output.png"
},
{
"height": 48,
"content_type": "image/png",
"width": 48,
"url": "https://storage.googleapis.com/falserverless/example_outputs/image2pixel-output-scaled.png",
"file_name": "image2pixel-output-scaled.png"
}
]
}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
height integerThe height of the image