Product Dimensions
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("bria/product-dimensions", {
input: {
image: "https://bria-datasets.s3.us-east-1.amazonaws.com/product_dimensions/water+bottle+fal/water_bottle_white_background.png",
dimensions: [{
unit: "cm",
name: "height",
position: "left",
value: 22
}, {
unit: "cm",
name: "width_bottom",
position: "bottom",
value: 7
}],
style: "default"
},
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("bria/product-dimensions", {
input: {
image: "https://bria-datasets.s3.us-east-1.amazonaws.com/product_dimensions/water+bottle+fal/water_bottle_white_background.png",
dimensions: [{
unit: "cm",
name: "height",
position: "left",
value: 22
}, {
unit: "cm",
name: "width_bottom",
position: "bottom",
value: 7
}],
style: "default"
},
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("bria/product-dimensions", {
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("bria/product-dimensions", {
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.
title_position TitlePositionEnumTitle placement along the top. Default value: "top_center"
Possible enum values: top_left, top_center, top_right
proportional_lines booleanScale dimension line lengths by measurement. Default value: true
sync booleanWhen true, return generated images directly as base64 instead of CDN URLs.
image string* requiredSource product image as a public URL or raw base64-encoded image bytes.
Dimension callouts to render. At least one entry is required.
style StyleEnum* requiredRendering style.
Possible enum values: default, childlike, elegant
title stringOptional headline above the product.
output_size integerSquare output edge length in pixels. Default value: 2200
output_format OutputFormatEnumControls the rendered response: png, jpeg, or dual composite plus transparent overlay. Default value: "png"
Possible enum values: png, jpeg, dual
background stringHex color or one of: white, cream, charcoal. Default value: "white"
units_display UnitsDisplayEnumHow labels display primary and secondary units when both are provided. Default value: "single"
Possible enum values: single, dual_bullet, dual_slash, dual_parens
Optional weight badge below the product.
Optional capacity badge below the product.
{
"title_position": "top_center",
"proportional_lines": true,
"image": "https://bria-datasets.s3.us-east-1.amazonaws.com/product_dimensions/water+bottle+fal/water_bottle_white_background.png",
"dimensions": [
{
"unit": "cm",
"name": "height",
"position": "left",
"value": 22
},
{
"unit": "cm",
"name": "width_bottom",
"position": "bottom",
"value": 7
}
],
"style": "default",
"title": "Water Bottle",
"output_size": 2200,
"output_format": "png",
"background": "white",
"units_display": "single"
}Rendered product dimensions image.
Transparent overlay returned only for output_format=dual.
{
"image": {
"url": "",
"content_type": "image/png",
"file_name": "z9RV14K95DvU.png",
"file_size": 4404019,
"width": 1024,
"height": 1024
}
}value float* requiredunit UnitEnum* requiredPossible enum values: fl_oz, ml, l, qt, gal, cups
name NameEnum* requiredDimension to render. length/depth are intentionally disabled.
Possible enum values: height, width_bottom, width_top
value float* requiredPhysical measurement value.
unit UnitEnum* requiredPhysical measurement unit.
Possible enum values: mm, cm, m, in, ", ft, '
position EnumCallout side; defaults by dimension name when omitted.
Possible enum values: top, bottom, left, right
value float* requiredunit UnitEnum* requiredPossible enum values: lb, oz, g, kg
label LabelEnumDefault value: "Weight"
Possible enum values: Weight, Net Weight
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.