Name: Bria Product Shadow Product Image Shadow API
Brand: magicapi
SKU: api-magicapi-add-custom-shadows-to-product-images-bria-product-shadow
Availability: InStock
Author: API Market

Shashank Agarwal

# 🛍️ Product Shadow API for Product Images (Bria Product Shadow)

## Overview
Bria Product Shadow adds a shadow under a product in a product image and places it on a background color you choose. Its developer describes it as adding consistent, customizable shadows to product cutouts for enhanced visual appeal.

Send a product cutout as `image`, pick a `shadow_type` (`regular` or `float`) and adjust color, offset, intensity, blur and size. If your image still has a background, set `force_rmbg` to `true`. Each request returns the URL of one image.

## Features
- **Two shadow types**: `regular` (default) or `float`, an elliptical shadow for products that appear to hover.
- **Background color**: any hex color (default `#FFFFFF`) or `transparent`.
- **Shadow color and strength**: `shadow_color` (default `#000000`) and `shadow_intensity` (0 to 100, default `60`).
- **Position**: `shadow_offset_x` (default `0`) and `shadow_offset_y` (default `15`) in pixels.
- **Shape**: `shadow_blur` for the softness of the edges, and `shadow_width` and `shadow_height` (default `70`) in pixels for floating shadows.
- **Background removal**: set `force_rmbg` to `true` to remove the background first, even if the image already has an alpha channel.
- **Transparency and moderation**: `preserve_alpha` (default `true`) keeps the alpha channel; `content_moderation` (default `false`) enables content moderation.

## Use Cases
1. **Catalog images**: give every product photo the same shadow and background for a consistent store.
2. **Marketplace listings**: grounded product shots on a white background.
3. **Floating product shots**: hover-style images with an elliptical shadow for hero banners and ads.
4. **Finishing cutouts**: add depth to product cutouts made by a background removal step.

## Visual Examples
### Example Input
Image (`image`), a 3D figure on a plain grey background used as a stand-in product:

![Input image: a 3D astronaut figure on a plain grey background](https://blog.api.market/wp-content/uploads/2026/09/kling-v2-6-motion-control-input-character-api-market.webp)

Settings: `force_rmbg` `true` (the input has a grey background), `shadow_type` `float`, `shadow_color` `#000000`, `shadow_intensity` `60`, `background_color` `#FFFFFF`. All other fields were left at their defaults.

### Example Output
![Bria Product Shadow output: the astronaut figure on a white background with a floating shadow beneath it](https://blog.api.market/wp-content/uploads/2026/10/product-shadow-output-api-market.png)

## Input Parameters
| Field | Type | Required | Default | Allowed values | Description |
| --- | --- | --- | --- | --- | --- |
| `image` | string (URL) | Yes |  |  | Product image to add shadow effects to |
| `shadow_type` | string | No | `regular` | `regular`, `float` | Type of shadow to apply: regular or float |
| `background_color` | string | No | `#FFFFFF` |  | The background hex color code (for example `#FFFFFF`) or `transparent` |
| `shadow_color` | string | No | `#000000` |  | Shadow color hex code |
| `shadow_offset_x` | integer | No | `0` |  | Horizontal shadow offset in pixels |
| `shadow_offset_y` | integer | No | `15` |  | Vertical shadow offset in pixels |
| `shadow_intensity` | integer | No | `60` |  | Adjusts the intensity of the shadow (0-100) |
| `shadow_blur` | integer | No | none |  | Controls the blur level of the shadow's edges |
| `shadow_width` | integer | No | none |  | Controls the width of the elliptical shadow in pixels (for floating shadows) |
| `shadow_height` | integer | No | `70` |  | Controls the height of the elliptical shadow in pixels (for floating shadows) |
| `force_rmbg` | boolean | No | `false` |  | Force background removal even if the image has an alpha channel |
| `preserve_alpha` | boolean | No | `true` |  | Preserve the alpha channel in the output |
| `content_moderation` | boolean | No | `false` |  | Enable content moderation |

## Pricing
- **Pay As You Go (PAYG) pricing**: you only pay for what you use.
- **Price**: $0.05 per API unit.
- **1 API unit = 1 output image.** Each request returns one image, so each successful request costs $0.05, including the example above.
- Every input setting (shadow type, background removal, colors) is billed the same.
- **Failed or cancelled predictions are not billed.**
- **GET requests to check prediction status** are free and don't count toward API unit usage.
- **No monthly subscription fee.**

## API Documentation

### Base URL
All API requests go to: `https://prod.api.market/api/v1/magicapi/add-custom-shadows-to-product-images-bria-product-shadow`

### Authentication
Send your api.market API key in the `x-api-market-key` header:
```
x-api-market-key: YOUR_API_MARKET_KEY
```

### Asynchronous Processing
**IMPORTANT**: This API is asynchronous. The flow is:
1. Send a POST request to `/predictions`. A successful request returns **201 Created** with a prediction `id` and a `status` of `starting` or `processing`.
2. Poll GET `/predictions/{id}` with that ID.
3. Keep polling while `status` is `starting` or `processing`.
4. Stop when `status` is `succeeded` (read `output`), `failed` or `canceled` (read `error`).

A polling interval of 1 second and an overall timeout of 600 seconds (10 minutes) work well.

### Endpoints

#### Create a Prediction
```bash
curl -X POST "https://prod.api.market/api/v1/magicapi/add-custom-shadows-to-product-images-bria-product-shadow/predictions" \
  -H "Content-Type: application/json" \
  -H "x-api-market-key: YOUR_API_MARKET_KEY" \
  -d '{
    "version": "ffed8143e81736c5fb32ed63ba7362935d8228687fa3b5173eab2fbf86f54ee6",
    "input": {
      "image": "https://blog.api.market/wp-content/uploads/2026/09/kling-v2-6-motion-control-input-character-api-market.webp",
      "force_rmbg": true,
      "shadow_type": "float",
      "shadow_color": "#000000",
      "shadow_intensity": 60,
      "background_color": "#FFFFFF"
    }
  }'
```

Response (201 Created):
```json
{
  "id": "ac3rt5p2tsrmy0d17fq9pjmtrm",
  "version": "ffed8143e81736c5fb32ed63ba7362935d8228687fa3b5173eab2fbf86f54ee6",
  "status": "starting",
  "created_at": "2026-10-14T19:41:05.747Z"
}
```

#### Check Prediction Status
```bash
curl -X GET "https://prod.api.market/api/v1/magicapi/add-custom-shadows-to-product-images-bria-product-shadow/predictions/{id}" \
  -H "x-api-market-key: YOUR_API_MARKET_KEY"
```

Response when the prediction has finished (200 OK):
```json
{
  "id": "ac3rt5p2tsrmy0d17fq9pjmtrm",
  "status": "succeeded",
  "output": "https://blog.api.market/wp-content/uploads/2026/10/product-shadow-output-api-market.png",
  "error": null,
  "created_at": "2026-10-14T19:41:05.747Z",
  "started_at": "2026-10-14T19:41:06.747Z",
  "completed_at": "2026-10-14T19:41:14.747Z"
}
```

`output` is a single URL string pointing to the PNG image with the shadow applied.

### Status Codes
- **201 Created**: prediction created (POST `/predictions`). This is the normal success response.
- **200 OK**: prediction details returned (GET `/predictions/{id}`).
- **400 Bad Request**: invalid input, for example a missing `image` or a `shadow_type` other than `regular` or `float`.
- **401 Unauthorized**: missing or invalid API key.
- **404 Not Found**: no prediction with that ID.
- **429 Too Many Requests**: rate limit exceeded.
- **500 Internal Server Error** or **503 Service Unavailable**: temporary server problem; retry later.

## Rate Limits

All plans allow 10 requests per second. Requests above that return `429 Too Many Requests`; back off before retrying and honour any `Retry-After` header. Polling a prediction with GET is free but still counts toward the per-second limit, so poll every 1 to 5 seconds rather than in a tight loop.

## Error Handling
- Check the HTTP status code of every request and read the response body for the error message.
- A prediction can also end with `status` set to `failed`; the `error` field then explains why. Failed predictions are not billed.
- Retry 429, 500 and 503 responses with exponential backoff. Fix the input before retrying a 400.

## Implementation Guide
### Example Code

#### JavaScript
```javascript
const apiKey = "YOUR_API_MARKET_KEY";
const baseUrl = "https://prod.api.market/api/v1/magicapi/add-custom-shadows-to-product-images-bria-product-shadow";

async function createAndWaitForPrediction(input) {
  const response = await fetch(`${baseUrl}/predictions`, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "x-api-market-key": apiKey
    },
    body: JSON.stringify({ version: "ffed8143e81736c5fb32ed63ba7362935d8228687fa3b5173eab2fbf86f54ee6", input })
  });

  if (response.status !== 201) {
    throw new Error(`API error: ${response.status} ${await response.text()}`);
  }

  const prediction = await response.json();
  return pollForResults(prediction.id);
}

const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));

async function pollForResults(predictionId) {
  const maxTimeout = 600000;
  const pollInterval = 1000;
  const startTime = Date.now();

  while (Date.now() - startTime < maxTimeout) {
    const response = await fetch(`${baseUrl}/predictions/${predictionId}`, {
      headers: { "x-api-market-key": apiKey }
    });

    if (!response.ok) {
      throw new Error(`API error: ${response.status} ${await response.text()}`);
    }

    const prediction = await response.json();

    if (prediction.status === "succeeded") {
      return prediction.output;
    }

    if (prediction.status === "failed" || prediction.status === "canceled") {
      throw new Error(`Prediction ${prediction.status}: ${prediction.error || "Unknown error"}`);
    }

    await delay(pollInterval);
  }

  throw new Error("Prediction timed out after 10 minutes");
}

createAndWaitForPrediction({
  "image": "https://blog.api.market/wp-content/uploads/2026/09/kling-v2-6-motion-control-input-character-api-market.webp",
  "force_rmbg": true,
  "shadow_type": "float",
  "shadow_color": "#000000",
  "shadow_intensity": 60,
  "background_color": "#FFFFFF"
}).then((output) => console.log(output));
```

#### Python
```python
import time
import requests

API_KEY = "YOUR_API_MARKET_KEY"
BASE_URL = "https://prod.api.market/api/v1/magicapi/add-custom-shadows-to-product-images-bria-product-shadow"

def create_and_wait_for_prediction(input_data):
    headers = {"Content-Type": "application/json", "x-api-market-key": API_KEY}
    response = requests.post(
        f"{BASE_URL}/predictions",
        headers=headers,
        json={"version": "ffed8143e81736c5fb32ed63ba7362935d8228687fa3b5173eab2fbf86f54ee6", "input": input_data},
    )

    if response.status_code != 201:
        raise Exception(f"API error: {response.status_code} {response.text}")

    return poll_for_results(response.json()["id"])

def poll_for_results(prediction_id):
    max_timeout = 600
    poll_interval = 1
    headers = {"x-api-market-key": API_KEY}
    start_time = time.time()

    while time.time() - start_time < max_timeout:
        response = requests.get(f"{BASE_URL}/predictions/{prediction_id}", headers=headers)

        if response.status_code != 200:
            raise Exception(f"API error: {response.status_code} {response.text}")

        prediction = response.json()

        if prediction["status"] == "succeeded":
            return prediction["output"]

        if prediction["status"] in ("failed", "canceled"):
            raise Exception(f"Prediction {prediction['status']}: {prediction.get('error') or 'Unknown error'}")

        time.sleep(poll_interval)

    raise Exception("Prediction timed out after 10 minutes")

print(create_and_wait_for_prediction({
    "image": "https://blog.api.market/wp-content/uploads/2026/09/kling-v2-6-motion-control-input-character-api-market.webp",
    "force_rmbg": True,
    "shadow_type": "float",
    "shadow_color": "#000000",
    "shadow_intensity": 60,
    "background_color": "#FFFFFF"
}))
```

## FAQ
- **Do I need to remove the background first?**
  - The model is meant for product cutouts. If your image still has a background, set `force_rmbg` to `true` and the background is removed before the shadow is added, as in the example.
- **What is the difference between `regular` and `float`?**
  - `float` draws an elliptical shadow whose size you set with `shadow_width` and `shadow_height`, so the product appears to hover. `regular` is the default shadow type.
- **Can I get a transparent background?**
  - Yes. Set `background_color` to `transparent`.
- **How many images does one request return?**
  - One, billed as one API unit ($0.05).
- **Is the 201 response from POST an error?**
  - No. 201 Created means the prediction was accepted. Use the returned `id` to poll GET `/predictions/{id}` until `status` is `succeeded`, `failed` or `canceled`.
- **What if my prediction fails?**
  - Failed predictions are not billed. Read the `error` field, adjust the input and try again.

## Contact Us

If you have any questions or need assistance, you can reach out to us through the embedded chat on the bottom right corner of the page or send an email to hello@magicapi.com.


Add customizable regular or floating shadows to product images with Bria Product Shadow, with optional background removal. $0.05 per image, pay as you go.