BackgroundErase icon

BackgroundErase

Remove image backgrounds with BackgroundErase

Actions3

Remove Background From File

AI-generated

Summary

Remove the background from an image file contained in an input binary property and return the processed image with customizable output settings.

Inputs

  • Input Binary Property (required) — Name of the incoming binary property that contains the image file to process.
  • File Name — Optional base name for the output filename; if empty, the incoming binary's filename is used.
  • Output Binary Property (required) — Name of the binary property to store the processed image output.
  • Output Type (required) — Choose between 'Alpha Mask' (grayscale mask PNG) or 'Transparent Image' (processed image with transparent background).
  • Output Format (required) — Output image format: JPG, PNG, or WebP. Note that Alpha Mask output is always PNG format.
  • Size (required) — Resolution choice for the output image: Auto, Full, HD, Medium, or Preview.
  • Crop to Subject (required) — Boolean flag to crop the output image to the detected foreground subject.
  • Remove Green Spill (required) — Boolean flag to reduce green-screen color spill artifacts around subject edges.
  • Background Color — Optional background color (e.g., #FFFFFF or named color) to apply behind the subject; leave empty for transparent.

Output shape

a single item containing a modified binary property with the processed image

The output binary property contains the background-removed image file, named according to the specified or incoming filename with an appropriate extension. The JSON output includes metadata such as output filename, mime-type, and billing details.

Examples

Example 1: Remove Background from an Uploaded Image File

Set 'Input Binary Property' to the binary property holding the image data; optionally provide a 'File Name' base; configure output options such as 'Output Type' (e.g., Transparent Image), 'Output Format' (e.g., PNG), 'Size' (e.g., Full), 'Crop to Subject', 'Remove Green Spill', and 'Background Color'. The node outputs the processed image as a binary property with background removed or replaced as specified.

Links

Discussion