Model ID

bria-product-dimensions

Calling method: sync

Bria Product Dimensions API Documentation

The Product Dimensions route turns a product photo and real-world measurements into a marketplace-ready dimension image, overlaying styled callouts for height, width, weight, and capacity onto a clean canvas.

1. API Endpoint & Authentication

Base URL: https://console.gmicloud.ai Endpoint: POST /api/v1/ie/requestqueue/apikey/requests Header: Authorization: Bearer YOUR_API_KEY Content-Type: application/json

2. Model Specifications

Pricing: $0.040 per image
Input Formats: JPEG, PNG, WEBP (Base64 string or URL)
Output: Square image, PNG (default) or JPEG, 256-2200 px per edge
Styles: Default, Childlike, Elegant
Required measurement: At least one of Height, Bottom Width, or Top Width must be provided

3. How It Works

Dimension Callouts

Provide a product photo along with its real-world measurements. The model places styled dimension callouts around the product on a clean canvas, sized and positioned according to the values you supply.

Required Measurements

At least one of the three dimension attributes must be provided: height_value, width_bottom_value, or width_top_value. A request supplying none of them will not produce a valid dimension image. Each measurement value must be greater than 0, and should be paired with its corresponding unit (height_unit, width_bottom_unit, width_top_unit). Weight and capacity are entirely optional and do not satisfy this requirement on their own.

Callout Placement & Units

Each dimension has a position parameter controlling which side of the product its callout sits on (top, bottom, left, or right). The units_display setting controls how primary and secondary units appear on the labels: a single unit, or dual units joined by a bullet, slash, or parentheses. Enabling proportional_lines scales each callout line’s length to its measurement.

Presentation

The style parameter selects the callout geometry and typography. The canvas background accepts a hex color (e.g. #0F766E) or one of the named presets: white, cream, or charcoal. An optional title (max 80 chars) can be placed along the top of the image.

4. Parameter Reference

Parameter	Type	Required	Description
image	image	Yes	Source product photo (URL or Base64; JPEG, PNG, WEBP).
style	enum	Yes	Callout geometry and typography: ‘default’, ‘childlike’, or ‘elegant’. Default: “default”.
height_value	float	No*	Height measurement (must be > 0). At least one of height_value, width_bottom_value, or width_top_value is required.
height_unit	enum	No	Unit for height: ‘mm’, ‘cm’, ‘m’, ‘in’, ‘ft’. Default: “cm”.
height_position	enum	No	Side for the height callout: ‘top’, ‘bottom’, ‘left’, ‘right’. Default: “left”.
width_bottom_value	float	No*	Bottom width measurement (must be > 0). At least one of height_value, width_bottom_value, or width_top_value is required.
width_bottom_unit	enum	No	Unit for bottom width: ‘mm’, ‘cm’, ‘m’, ‘in’, ‘ft’. Default: “cm”.
width_bottom_position	enum	No	Side for the bottom-width callout: ‘top’, ‘bottom’, ‘left’, ‘right’. Default: “bottom”.
width_top_value	float	No*	Top width measurement (must be > 0). At least one of height_value, width_bottom_value, or width_top_value is required.
width_top_unit	enum	No	Unit for top width: ‘mm’, ‘cm’, ‘m’, ‘in’, ‘ft’. Default: “cm”.
width_top_position	enum	No	Side for the top-width callout: ‘top’, ‘bottom’, ‘left’, ‘right’. Default: “top”.
weight_value	float	No	Optional weight measurement (must be > 0).
weight_unit	enum	No	Unit for weight: ‘lb’, ‘oz’, ‘g’, ‘kg’. Default: “kg”.
weight_label	enum	No	Label for the weight callout: ‘Weight’ or ‘Net Weight’. Default: “Weight”.
capacity_value	float	No	Optional capacity measurement (must be > 0).
capacity_unit	enum	No	Unit for capacity: ‘fl_oz’, ‘ml’, ‘l’, ‘qt’, ‘gal’, ‘cups’. Default: “ml”.
units_display	enum	No	Label unit format: ‘single’, ‘dual_bullet’, ‘dual_slash’, ‘dual_parens’. Default: “single”.
background	string	No	Canvas background: hex (e.g. #0F766E) or white, cream, charcoal. Default: “white”.
title	string	No	Optional headline above the product (max 80 chars).
title_position	enum	No	Title placement: ‘top_left’, ‘top_center’, ‘top_right’. Default: “top_center”.
output_format	enum	No	Output image format: ‘png’ or ‘jpeg’. Default: “png”.
output_size	integer	No	Square output edge length in pixels (256-2200). Default: 2200.
proportional_lines	boolean	No	Scale callout line length to the measurement. Default: true.

*At least one of height_value, width_bottom_value, or width_top_value must be provided.

5. Example CURL Request

curl -X POST "https://console.gmicloud.ai/api/v1/ie/requestqueue/apikey/requests" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "bria-product-dimensions",
    "payload": {
      "image": "https://example.com/product_photo.jpg",
      "style": "default",
      "height_value": 24.5,
      "height_unit": "cm",
      "height_position": "left",
      "width_bottom_value": 12,
      "width_bottom_unit": "cm",
      "width_bottom_position": "bottom",
      "background": "white",
      "output_format": "png",
      "output_size": 2200
    }
  }'

6. Checking Request Status

Endpoint: GET /api/v1/ie/requestqueue/apikey/requests/{request_id}

queued: Request is waiting to be processed by GPU resources.
processing: Image processing is currently in progress.
success: Processing completed. URLs available in outcome.media_urls.
failed: Processing failed. Check logs for details.

Overview

Model Quickstarts

Agents

Coding Tools

AgentBox Guides

Migration Guides

bria-product-dimensions

Bria Product Dimensions API Documentation

1. API Endpoint & Authentication

2. Model Specifications

3. How It Works

Dimension Callouts

Required Measurements

Callout Placement & Units

Presentation

4. Parameter Reference

5. Example CURL Request

6. Checking Request Status

​Bria Product Dimensions API Documentation

​1. API Endpoint & Authentication

​2. Model Specifications

​3. How It Works

​Dimension Callouts

​Required Measurements

​Callout Placement & Units

​Presentation

​4. Parameter Reference

​5. Example CURL Request

​6. Checking Request Status

Bria Product Dimensions API Documentation

1. API Endpoint & Authentication

2. Model Specifications

3. How It Works

Dimension Callouts

Required Measurements

Callout Placement & Units

Presentation

4. Parameter Reference

5. Example CURL Request

6. Checking Request Status