Bria Product Shot
/v1/runProduct Shot by Bria - AI-powered image editing, style transfer, and transformation. Edit photos with natural language instructions, remove backgrounds, change styles, and enhance images effortlessly.
Request body
Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.
Model identifier. Set to bria/product-shot.
Default: bria/product-shot
The URL of the product shot to be placed in a lifestyle shot. If both image_url and image_file are provided, image_url will be used. Accepted formats are jpeg, jpg, png, webp. Maximum file size 12MB.
Whether to use the fast model
Default: true
The number of lifestyle product shots you would like to generate. You will get num_results x 10 results when placement_type=automatic and according to the number of required placements x num_results if placement_type=manual_placement.
Range: 1 to 4
Default: 1
If you've selected placement_type=manual_placement, you should use this parameter to specify which placements/positions you would like to use from the list. You can select more than one placement in one request.
Allowed values: upper_left, upper_right, bottom_left, bottom_right, right_center, left_center, upper_center, bottom_center, center_vertical, center_horizontal
Default: bottom_center
The desired size of the final product shot. For optimal results, the total number of pixels should be around 1,000,000. This parameter is only relevant when placement_type=automatic or placement_type=manual_placement.
Default: 1000,1000
The URL of the reference image to be used for generating the new scene or background for the product shot. Use "" to leave empty.Either ref_image_url or scene_description has to be provided but not both. If both ref_image_url and ref_image_file are provided, ref_image_url will be used. Accepted formats are jpeg, jpg, png, webp.
Default:
The desired padding in pixels around the product, when using placement_type=manual_padding. The order of the values is [left, right, top, bottom]. For optimal results, the total number of pixels, including padding, should be around 1,000,000. It is recommended to first use the product cutout API, get the cutout and understand the size of the result, and then define the required padding and use the cutout as an input for this API.
Text description of the new scene or background for the provided product shot. Bria currently supports prompts in English only, excluding special characters.
This flag is only relevant when placement_type=original. If true, the output image retains the original input image's size; otherwise, the image is scaled to 1 megapixel (1MP) while preserving its aspect ratio.
Default: false
Whether to optimize the scene description
Default: true
This parameter allows you to control the positioning of the product in the image. Choosing 'original' will preserve the original position of the product in the image. Choosing 'automatic' will generate results with the 10 recommended positions for the product. Choosing 'manual_placement' will allow you to select predefined positions (using the parameter 'manual_placement_selection'). Selecting 'manual_padding' will allow you to control the position and size of the image by defining the desired padding in pixels around the product.
Allowed values: original, automatic, manual_placement, manual_padding
Default: manual_placement
Response Schema
The submit endpoint returns an accepted generation task. Poll the result endpoint with the returned id for terminal outputs or errors.
Error message if the task failed. Empty on success.
Unique identifier for the generation task.
Model ID used for the prediction.
Array of generated content. Empty when status is not completed.
Status of the task: pending, running, completed, failed, or timeout.
Allowed values: pending, running, completed, failed, timeout
Model capabilities
Capabilities declared by the model registry.
Default: image-to-image
Execution mode declared by the model registry.
Default: async