fal Assets is now live!
Docs
Log-inSign-up

Bria AI logo
bria/product-dimensions

Bria Product Dimensions turns one product photo and its measurements into a marketplace-ready dimension image with callout lines, labels, and weight or capacity readouts
Inference
Commercial use
Partner
Schema
LLMs
PlaygroundAPI

Table of contents

About

Product Dimensions

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/product-dimensions", {
  input: {
    image: "https://bria-datasets.s3.us-east-1.amazonaws.com/product_dimensions/water+bottle+fal/water_bottle_white_background.png",
    dimensions: [{
      position: "left",
      name: "height",
      value: 22,
      unit: "cm"
    }, {
      position: "bottom",
      name: "width_bottom",
      value: 7,
      unit: "cm"
    }],
    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);

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 case your app is running in an environment where you cannot set environment variables, you can set the API Key manually as a client configuration.
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/product-dimensions", {
  input: {
    image: "https://bria-datasets.s3.us-east-1.amazonaws.com/product_dimensions/water+bottle+fal/water_bottle_white_background.png",
    dimensions: [{
      position: "left",
      name: "height",
      value: 22,
      unit: "cm"
    }, {
      position: "bottom",
      name: "width_bottom",
      value: 7,
      unit: "cm"
    }],
    style: "default"
  },
  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/product-dimensions", {
  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/product-dimensions", {
  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#

title_position TitlePositionEnum

Title placement along the top. Default value: "top_center"

Possible enum values: top_left, top_center, top_right

proportional_lines boolean

Scale dimension line lengths by measurement. Default value: true

sync boolean

When true, return generated images directly as base64 instead of CDN URLs.

image string* required

Source product image as a public URL or raw base64-encoded image bytes.

dimensions list<DimensionEntry>* required

Dimension callouts to render. At least one entry is required.

style StyleEnum* required

Rendering style.

Possible enum values: default, childlike, elegant

title string

Optional headline above the product.

output_size integer

Square output edge length in pixels. Default value: 2200

output_format OutputFormatEnum

Controls the rendered response: png, jpeg, or dual composite plus transparent overlay. Default value: "png"

Possible enum values: png, jpeg, dual

background string

Hex color or one of: white, cream, charcoal. Default value: "white"

units_display UnitsDisplayEnum

How labels display primary and secondary units when both are provided. Default value: "single"

Possible enum values: single, dual_bullet, dual_slash, dual_parens

weight WeightInput

Optional weight badge below the product.

capacity CapacityInput

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": [
    {
      "position": "left",
      "name": "height",
      "value": 22,
      "unit": "cm"
    },
    {
      "position": "bottom",
      "name": "width_bottom",
      "value": 7,
      "unit": "cm"
    }
  ],
  "style": "default",
  "title": "Water Bottle",
  "output_size": 2200,
  "output_format": "png",
  "background": "white",
  "units_display": "single"
}

Output#

image Image* required

Rendered product dimensions image.

transparent_overlay 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
  }
}

Other types#

DimensionEntry#

name NameEnum* required

Dimension to render. length/depth are intentionally disabled.

Possible enum values: height, width_bottom, width_top

value float* required

Physical measurement value.

unit UnitEnum* required

Physical measurement unit.

Possible enum values: mm, cm, m, in, ", ft, '

position Enum

Callout side; defaults by dimension name when omitted.

Possible enum values: top, bottom, left, right

Image#

url string* required

The URL where the file can be downloaded from.

content_type string

The mime type of the file.

file_name string

The name of the file. It will be auto-generated if not provided.

file_size integer

The size of the file in bytes.

width integer

The width of the image in pixels.

height integer

The height of the image in pixels.

Related Models