Products

Product Cutout

Changed on

Try out this capability in Bria's sandbox

Description

This capability allows you to create a precise cutout of a product from any given image. This feature is especially valuable for eCommerce platforms and applications, serving as a fundamental building block for crafting a user-friendly interface.

This API endpoint supports content moderation via an optional parameter that can prevent processing if input images contain inappropriate content or if the modified output would contain inappropriate content.

post/product/cutout

Request

  • Base URL: https://engine.prod.bria-api.com/v1
  • URL: https://engine.prod.bria-api.com/v1/product/cutout
  • Auth: API key in header api_token

Request body

skustring

The Stock Keeping Unit identifier for the product. This parameter is optional.

image_urlstring

The URL of the image containing the product to be cut out. If both image_url and file are provided, image_url will be used. Accepted formats are jpeg, jpg, png, webp. Maximum file size 12MB.

filestring

The image file containing the product to be cut out, in base64 format. Used if image_url is not provided. Accepted formats are jpeg, jpg, png, webp. Maximum file size 12MB.

force_rmbgboolean

Forces background removal, even if the original image already contains an alpha channel. Useful for refining existing foreground/background separation or ignoring unnecessary alpha channels.

preserve_alphaboolean

Controls whether the alpha channel values from the input image are retained in the output, if the input includes an alpha channel.

  • When true: The output image maintains the original transparency of fully and partially transparent pixels.
  • When false: The transparency values from the input are not preserved, but the output may still include an alpha channel (e.g., around the cropped area).
  • Has no effect if the input image does not include an alpha channel.
content_moderationboolean

When enabled, applies content moderation to both input visuals and modified outputs.

For input images:

  • Processing stops if the image fails moderation
  • Returns a 422 error with details about which parameter failed

For output images:

  • If the modified image fails moderation, returns a 422 error

Response

Successful operation.

result_urlstring

The URL of the processed product cutout image. This is a temporary URL that expires after 1 hour.

Changes

  • ac924fd17279Revision changes
    • warning

      deleted the header request parameter api_token

    • info

      api tag Products added

    • info

      api tag Product Endpoints removed