> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gmicloud.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# bria-product-dimensions

> API usage guide for bria-product-dimensions.

{/* source_model_id: bria-product-dimensions */}

{/* source_updated_at: 1784141246 */}

**Model ID**

```bash theme={null}
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](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

```bash theme={null}
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

```bash theme={null}
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.