Bria Product Holding API Documentation
Playground
Try it on WaveSpeedAI!Bria Product Holding places products naturally in a person’s hands using a person photo, one to three product reference images, and optional text instructions, making it suitable for product advertising, e-commerce visuals, influencer-style content, and marketing workflows. Ready-to-use REST inference API, best performance, no coldstarts, affordable pricing.
Features
Bria Product Holding places referenced products naturally into a person’s hands using a person photo, one to three product reference images, and optional text instructions. It is designed for product presentation, lifestyle advertising, and e-commerce workflows where a person needs to hold or interact with a supplied product.
Why Choose This?
-
Purpose-built editing
Create natural product-holding images from person and product references. -
Multi-reference support
Combine one person photo with one to three product reference images. -
Optional prompt guidance
Images alone are sufficient. Add a prompt only when you want to direct a specific edit. -
Original framing by default
Omitaspect_ratioto retain the person photo’s aspect ratio. -
Standard image output
Receive a PNG or JPEG image URL in the standard WaveSpeed prediction response.
Parameters
| Parameter | Required | Description |
|---|---|---|
| image | Yes | Person photo to edit. Public image URL or Base64-encoded image. JPEG, JPG, PNG, and WEBP are supported. |
| reference_images | Yes | One to three product reference images, supplied as public URLs or Base64-encoded images. These are separate from image. |
| prompt | No | Optional instructions to guide the edit. Omit to use the model’s built-in instructions. |
| aspect_ratio | No | Output aspect ratio: 1:1, 2:3, 3:2, 3:4, 4:3, 4:5, 5:4, 9:16, or 16:9. Omit to preserve the person photo’s aspect ratio. |
| output_format | No | Output image format: png or jpeg. Default: png. |
| seed | No | Random seed for generation. Omit for a random seed. |
How to Use
- Upload a person photo - Provide the base person image in
image. - Add reference images - Supply one to three product images in
reference_images. - Guide the edit optionally - Add a concise
promptfor placement or styling details. - Choose output settings - Optionally set the aspect ratio, output format, and seed.
- Submit - Poll the prediction result and retrieve the generated image URL.
Pricing
Pricing is fixed at $0.04 per generated image. Each successful request returns one image.
| Output | Price |
|---|---|
| One generated image | $0.04 |
One to three reference images are included at the same price. prompt, aspect_ratio, output_format, and seed do not add separate charges.
Best Use Cases
- E-commerce lifestyle images
- Handheld product campaigns
- Packaging and companion-item compositions
Pro Tips
- Use a clear person photo with the relevant body area visible.
- Show the product clearly, including logos and packaging details. Use the prompt to specify the hand, orientation, or placement.
- Leave
aspect_ratiounset when you want to preserve the original framing. - Keep all input image URLs publicly accessible while the request is processing.
- Use a fixed seed when comparing prompt changes.
Notes
imageandreference_imagesare required;promptis optional.- The limit is one person photo plus one to three reference images, for two to four images in total.
Related Models
- Bria Virtual Try-On — Apply garment or accessory references to an existing person photo for virtual try-on workflows.
- Bria Product Holding — Generate images of a person naturally holding or presenting a referenced product.
Authentication
For authentication details, please refer to the Authentication Guide.
API Endpoints
Submit Task & Query Result
set -euo pipefail
export WAVESPEED_API_KEY="your-api-key"
REQUEST_BODY=$(cat <<'JSON'
{
"image": "https://interactive-examples.mdn.mozilla.net/media/cc0-images/painted-hand-298-332.jpg",
"reference_images": [
"https://interactive-examples.mdn.mozilla.net/media/cc0-images/painted-hand-298-332.jpg"
],
"aspect_ratio": "1:1",
"output_format": "png"
}
JSON
)
# 1. Submit the prediction.
SUBMIT_RESPONSE=$(curl --silent --show-error --fail-with-body \
-X POST "https://api.wavespeed.ai/api/v3/bria/product-holding" \
-H "Authorization: Bearer ${WAVESPEED_API_KEY}" \
-H "Content-Type: application/json" \
-d "${REQUEST_BODY}")
TASK=$(printf '%s' "${SUBMIT_RESPONSE}" | jq 'if type == "object" and has("data") then .data else . end')
PREDICTION_ID=$(printf '%s' "${TASK}" | jq -r '.id // empty')
if [ -z "${PREDICTION_ID}" ]; then
printf 'Submission response did not contain a prediction id
' >&2
exit 1
fi
RESULT_URL="https://api.wavespeed.ai/api/v3/predictions/${PREDICTION_ID}/result"
# 2. Poll until the prediction finishes.
while true; do
RESPONSE=$(curl --silent --show-error --fail-with-body \
"${RESULT_URL}" \
-H "Authorization: Bearer ${WAVESPEED_API_KEY}")
RESULT=$(printf '%s' "${RESPONSE}" | jq 'if type == "object" and has("data") then .data else . end')
STATUS=$(printf '%s' "${RESULT}" | jq -r '.status // empty')
case "${STATUS}" in
completed) printf '%s\n' "${RESULT}" | jq '.outputs'; break ;;
failed|cancelled|timeout|deleted) printf '%s\n' "${RESULT}" | jq . >&2; exit 1 ;;
*) sleep 2 ;;
esac
doneParameters
Task Submission Parameters
Request Parameters
| Parameter | Type | Required | Default | Range | Description |
|---|---|---|---|---|---|
| image | string | Yes | - | The person photo to edit. Public image URL or Base64-encoded image. Supported formats: JPEG, JPG, PNG, and WEBP. | |
| reference_images | array<string> | Yes | - | 1 ~ 3 items | One to three product reference images. Each entry is a public image URL or Base64-encoded image. These are separate from the person photo in image. |
| prompt | string | No | - | Optional instructions to guide the edit. Omit to use the model's built-in instructions. | |
| aspect_ratio | string | No | - | 1:1, 2:3, 3:2, 3:4, 4:3, 4:5, 5:4, 9:16, 16:9 | Optional output aspect ratio. Omit to preserve the person photo's original aspect ratio. |
| output_format | string | No | png | png, jpeg | Output image format. Default: png. |
| seed | integer | No | - | - | Random seed for generation. Omit to let the upstream service choose a random seed. |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| code | integer | HTTP status code (e.g., 200 for success) |
| message | string | Status message (e.g., “success”) |
| data.id | string | Unique identifier for the prediction, Task Id |
| data.model | string | Model ID used for the prediction |
| data.outputs | array | Output values, usually URL strings; some models return text strings or structured result objects (empty when status is not completed) |
| data.urls | object | Object containing related API endpoints |
| data.status | string | Task status. completed is successful; failed, cancelled, timeout, and deleted are failure terminal statuses. |
| data.created_at | string | ISO timestamp of when the request was created (e.g., “2023-04-01T12:34:56.789Z”) |
| data.error | string | Error message (empty if no error occurred) |
| data.timings | object | Object containing timing details |
| data.timings.inference | integer | Inference time in milliseconds |
Result Request Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| id | string | Yes | - | Task ID |
Result Response Parameters
| Parameter | Type | Description |
|---|---|---|
| code | integer | HTTP status code (e.g., 200 for success) |
| message | string | Status message (e.g., “success”) |
| data | object | The prediction data object containing all details |
| data.id | string | Unique identifier for the prediction |
| data.model | string | Model ID used for the prediction |
| data.outputs | array<string | object> | Array of generated outputs (empty when status is not completed). Items are usually URL strings, but may be text strings or structured result objects, depending on the model. |
| data.urls | object | Object containing related API endpoints |
| data.status | string | Status: completed is successful; failed, cancelled, timeout, and deleted are failure terminal statuses |
| data.created_at | string | ISO timestamp of when the request was created |
| data.error | string | Error message (empty if no error occurred) |
| data.timings | object | Object containing timing details |
| data.timings.inference | integer | Inference time in milliseconds |