Loading API documentation
Process Image
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/post-processing", {
input: {
image_url: "https://storage.googleapis.com/falserverless/web-examples/post-process/postpro-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/post-processing", {
input: {
image_url: "https://storage.googleapis.com/falserverless/web-examples/post-process/postpro-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/post-processing", {
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/post-processing", {
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* requiredURL of image to process
enable_grain booleanEnable film grain effect
grain_intensity floatFilm grain intensity (when enabled) Default value: 0.4
grain_scale floatFilm grain scale (when enabled) Default value: 10
grain_style GrainStyleEnumStyle of film grain to apply Default value: "modern"
Possible enum values: modern, analog, kodak, fuji, cinematic, newspaper
enable_color_correction booleanEnable color correction
temperature floatColor temperature adjustment
brightness floatBrightness adjustment
contrast floatContrast adjustment
saturation floatSaturation adjustment
gamma floatGamma adjustment Default value: 1
enable_chromatic booleanEnable chromatic aberration
red_shift integerRed channel shift amount
red_direction RedDirectionEnumRed channel shift direction Default value: "horizontal"
Possible enum values: horizontal, vertical
green_shift integerGreen channel shift amount
green_direction GreenDirectionEnumGreen channel shift direction Default value: "horizontal"
Possible enum values: horizontal, vertical
blue_shift integerBlue channel shift amount
blue_direction BlueDirectionEnumBlue channel shift direction Default value: "horizontal"
Possible enum values: horizontal, vertical
enable_blur booleanEnable blur effect
blur_type BlurTypeEnumType of blur to apply Default value: "gaussian"
Possible enum values: gaussian, kuwahara
blur_radius integerBlur radius Default value: 3
blur_sigma floatSigma for Gaussian blur Default value: 1
enable_vignette booleanEnable vignette effect
vignette_strength floatVignette strength (when enabled) Default value: 0.5
enable_parabolize booleanEnable parabolize effect
parabolize_coeff floatParabolize coefficient Default value: 1
vertex_x floatVertex X position Default value: 0.5
vertex_y floatVertex Y position Default value: 0.5
enable_tint booleanEnable color tint effect
tint_strength floatTint strength Default value: 1
tint_mode TintModeEnumTint color mode Default value: "sepia"
Possible enum values: sepia, red, green, blue, cyan, magenta, yellow, purple, orange, warm, cool, lime, navy, vintage, rose, teal, maroon, peach, lavender, olive
enable_dissolve booleanEnable dissolve effect
dissolve_image_url stringURL of second image for dissolve Default value: ""
dissolve_factor floatDissolve blend factor Default value: 0.5
enable_dodge_burn booleanEnable dodge and burn effect
dodge_burn_intensity floatDodge and burn intensity Default value: 0.5
dodge_burn_mode DodgeBurnModeEnumDodge and burn mode Default value: "dodge"
Possible enum values: dodge, burn, dodge_and_burn, burn_and_dodge, color_dodge, color_burn, linear_dodge, linear_burn
enable_glow booleanEnable glow effect
glow_intensity floatGlow intensity Default value: 1
glow_radius integerGlow blur radius Default value: 5
enable_sharpen booleanEnable sharpen effect
sharpen_mode SharpenModeEnumType of sharpening to apply Default value: "basic"
Possible enum values: basic, smart, cas
sharpen_radius integerSharpen radius (for basic mode) Default value: 1
sharpen_alpha floatSharpen strength (for basic mode) Default value: 1
noise_radius integerNoise radius for smart sharpen Default value: 7
preserve_edges floatEdge preservation factor Default value: 0.75
smart_sharpen_strength floatSmart sharpen strength Default value: 5
smart_sharpen_ratio floatSmart sharpen blend ratio Default value: 0.5
cas_amount floatCAS sharpening amount Default value: 0.8
enable_solarize booleanEnable solarize effect
solarize_threshold floatSolarize threshold Default value: 0.5
enable_desaturate booleanEnable desaturation effect
desaturate_factor floatDesaturation factor Default value: 1
desaturate_method DesaturateMethodEnumDesaturation method Default value: "luminance (Rec.709)"
Possible enum values: luminance (Rec.709), luminance (Rec.601), average, lightness
{
"image_url": "https://storage.googleapis.com/falserverless/web-examples/post-process/postpro-input.jpg",
"grain_intensity": 0.4,
"grain_scale": 10,
"grain_style": "modern",
"gamma": 1,
"red_direction": "horizontal",
"green_direction": "horizontal",
"blue_direction": "horizontal",
"blur_type": "gaussian",
"blur_radius": 3,
"blur_sigma": 1,
"vignette_strength": 0.5,
"parabolize_coeff": 1,
"vertex_x": 0.5,
"vertex_y": 0.5,
"tint_strength": 1,
"tint_mode": "sepia",
"dissolve_factor": 0.5,
"dodge_burn_intensity": 0.5,
"dodge_burn_mode": "dodge",
"glow_intensity": 1,
"glow_radius": 5,
"sharpen_mode": "basic",
"sharpen_radius": 1,
"sharpen_alpha": 1,
"noise_radius": 7,
"preserve_edges": 0.75,
"smart_sharpen_strength": 5,
"smart_sharpen_ratio": 0.5,
"cas_amount": 0.8,
"solarize_threshold": 0.5,
"desaturate_factor": 1,
"desaturate_method": "luminance (Rec.709)"
}The processed images
{
"images": [
{
"url": "",
"content_type": "image/png",
"file_name": "z9RV14K95DvU.png",
"file_size": 4404019,
"width": 1024,
"height": 1024
}
]
}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.