The BackgroundErase n8n node lets you remove image backgrounds as part of an automated workflow. You can process binary image data from a previous node, process an image URL already present in your workflow, or use the universal API operation for advanced BackgroundErase requests.
Best fit: Use this integration for catalog cleanup, ecommerce image workflows, Airtable attachment processing, Shopify product image updates, CMS asset cleanup, Google Drive and Dropbox automations, webhook uploads, form uploads, spreadsheet-driven image workflows, and internal operations flows where n8n already moves the image.
Install the n8n community node
The package name is @backgrounderase/n8n-nodes-backgrounderase. Self-hosted n8n users can install it from npm under Settings > Community Nodes.
- Open Settings > Community Nodes > Install.
- Enter @backgrounderase/n8n-nodes-backgrounderase.
- Confirm the community node warning.
- Restart n8n if your deployment requires it.
- After install, search for BackgroundErase in the node panel.
Unverified community nodes are installed from npm on self-hosted n8n. n8n Cloud availability depends on n8n verification and your workspace's verified community node settings.
Create and connect an API key
BackgroundErase uses API key authentication. The BackgroundErase API credential stores the key and sends it automatically as x-api-key.
- Create a Business account BackgroundErase API access is available on Business and Enterprise plans.
- Generate an API key Open your BackgroundErase account page, create an API key, and keep it private while you set up n8n.
- Create the BackgroundErase API credential In n8n, create a new credential named BackgroundErase API, paste the API key, then save and test the credential.
Keep the key inside the n8n credential. Do not expose it in workflow fields, Set nodes, spreadsheet rows, webhook payloads, browser code, logs, or output data.
- API base: https://api.backgrounderase.com
- Credential test: GET /v2/account
- Main processing endpoint: POST /v2
- Dedicated image operations use multipart/form-data.
How billing works
BackgroundErase uses metered monthly billing for n8n workflows. Each successfully processed image counts as one billable image for the billing period.
The n8n node returns billing fields such as billing_model, usage_unit, and billable_units so your team can understand how workflow executions map to BackgroundErase usage.
Choose the right operation
Most workflows should use one of the two dedicated background removal operations. The universal API operation is for advanced requests and account checks.
Remove Background From File
Use this when an earlier n8n node gives you binary image data from Google Drive, Dropbox, an email attachment, webhook upload, form upload, or HTTP Request download.
Remove Background From Image URL
Use this when your workflow already has a public or signed image URL from Airtable, Shopify, Webflow, Google Sheets, a webhook, or an external CMS.
Make an API Call
Use this for advanced API requests, account checks, future endpoints, custom workflows, or debugging authenticated calls.
Walkthrough: remove background from a file
Use Remove Background From File when an earlier n8n node provides binary image data. The operation reads binary data from the configured input binary property, sends it to BackgroundErase as multipart/form-data using the image_file field, and returns the processed image as binary data on the configured output binary property.
- Start with a node that produces binary image data, such as HTTP Request, Google Drive, Dropbox, Gmail attachment, webhook upload, or form upload.
- If the source node only provides metadata or a URL, add a download step first.
- Add the BackgroundErase node.
- Choose Remove Background From File.
- Set Input Binary Property. In many n8n workflows this is data.
- Optionally set File Name.
- Set Output Binary Property, usually data.
- Choose output options: transparent PNG, WebP, JPG with background color, crop, despill, or alpha mask.
- Execute the node.
- Send the returned binary image to another node, such as Google Drive, Dropbox, S3, Airtable, Shopify, a CMS, or your own storage step.
Input Binary Property
Required. Defaults to data. This must match the incoming binary property that contains the source image.
File Name
Optional. If blank, n8n uses the incoming binary filename when available.
Output Binary Property
Required. Defaults to data. This is where the processed image will be returned.
Output Type
Required. Defaults to Transparent Image. Choose Transparent Image or Alpha Mask.
Output Format
Required. Defaults to PNG. Choose PNG, WebP, or JPG. PNG is recommended for transparency, and alpha mask output is always PNG.
Size and cleanup
Choose Preview, Medium, HD, Full, or Auto. Optional cleanup fields include Crop to Subject, Remove Green Spill, and Background Color.
If you are unsure which operation to use, start with the file operation. It avoids many URL permission issues because n8n passes the image file directly to BackgroundErase.
Walkthrough: remove background from an image URL
Use Remove Background From Image URL when the workflow already has a public or signed image URL. The operation sends the URL to BackgroundErase as multipart/form-data using the image_url field. BackgroundErase fetches the image server-side and returns the processed image as binary data.
- Start with a node that provides an image URL, such as Airtable, Shopify, Webflow, Google Sheets, a webhook, or an external CMS.
- Add the BackgroundErase node.
- Choose Remove Background From Image URL.
- Map the URL into Image URL.
- Optionally set Output Base Name.
- Set Output Binary Property, usually data.
- Choose output type, format, size, crop, despill, and background color.
- Execute the node.
- Save the returned binary image to storage, attach it to a record, update a product image, or pass it into another n8n node.
Image URL
Required. Map a publicly reachable URL or signed URL for the image to process.
Output Base Name
Optional. Defaults to backgrounderase-image and controls the output filename base.
Output Binary Property
Required. Defaults to data. This is where the processed image will be returned.
Output Type
Required. Defaults to Transparent Image. Choose Transparent Image or Alpha Mask.
Output Format
Required. Defaults to PNG. Choose PNG, WebP, or JPG.
Size and cleanup
Choose Preview, Medium, HD, Full, or Auto. Use crop, despill, and Background Color as needed.
The URL must be reachable by BackgroundErase's backend. Private Google Drive links, expired signed URLs, login-protected URLs, and internal network URLs may fail. If that happens, download the file in n8n first and use Remove Background From File instead.
Universal API operation for advanced calls
The Make an API Call operation is for advanced BackgroundErase requests. Use it to call an endpoint directly, test a new API parameter, debug authentication, or check account status.
- URL: /v2/account
- Method: GET
- Headers: {}
- Query String: {}
- Body: {}
The response should show whether the API key is valid and what billing model the account uses. For normal image processing, use the dedicated file or URL operations instead. They provide a cleaner interface and return the processed image as binary data ready for downstream n8n nodes.
Output fields
The dedicated image operations return JSON metadata plus a processed image on the configured output binary property, usually data.
Remove Background From File
JSON metadata includes name, MIME type, Billing Model, Usage Unit, and Billable Units. The processed image is returned as binary data on the configured Output Binary Property.
Remove Background From Image URL
JSON metadata includes name, MIME type, Billing Model, Usage Unit, Billable Units, and Source URL. The processed image is returned as binary data on the configured Output Binary Property.
Make an API Call
Returns body, headers, and statusCode.
Supported options
The file and URL operations expose the same practical controls as the BackgroundErase API. Start simple, then add options as your destination node requires them.
Output Type
Choose Transparent Image for normal cutouts or Alpha Mask when the next node handles compositing.
Format
Choose PNG, WebP, or JPG. PNG is best for transparency. Alpha mask output is always returned as PNG.
Size
Choose preview, medium, HD, full, or auto depending on how much detail the downstream node needs.
Crop
Enable Crop to Subject when you want the output trimmed around the detected foreground.
Despill
Enable Remove Green Spill for green-screen style photos where color bleed appears around edges.
Background Color
Set Background Color to flatten the result onto a color such as #FFFFFF or white. Leave it empty for transparent output.
For the full API reference, see the request fields and flags docs.
Limits to know before you turn on a workflow
- Max file size: images can be up to 30 MB.
- Max pixels: source images can be up to 100,000,000 pixels.
- Private URLs: image URLs must be reachable by BackgroundErase.
- Login-protected URLs, expired signed URLs, private Drive links, and internal network URLs may fail.
- The dedicated file and URL operations use multipart/form-data automatically.
- Alpha mask output is always PNG.
- JPG output does not preserve transparency, so use a background color or expect a flattened image.
- For file workflows, the previous node must provide binary data, not just metadata.
Troubleshooting common n8n errors
Invalid API key
Open the BackgroundErase API credential in n8n and paste a fresh API key from your account. The credential adds the x-api-key header automatically, so you should not add it manually.
API key helpImage too large
BackgroundErase accepts images up to 30 MB and 100,000,000 pixels. Resize the source image or use a smaller export before sending it through the workflow.
Size helpPrivate image URL
The URL operation can only process URLs that BackgroundErase can fetch from its backend. Private Drive links, expired signed URLs, login-protected URLs, and internal network URLs may fail.
URL helpBad background color
Use a valid hex color such as #FFFFFF or a supported named color such as white. If you do not need a flattened background, leave Background Color empty.
Color helpNo binary data found
The previous node may only be returning JSON metadata. Add a download step or configure the source node to download the file as binary data. Make sure Input Binary Property matches the binary property name, commonly data.
Output image missing
Check Output Binary Property. Downstream nodes should map the binary output property, usually data, not only the JSON filename.
Community node not visible
Make sure the package is installed under Settings > Community Nodes, restart n8n if needed, and search for BackgroundErase in the node panel. On n8n Cloud, availability depends on verification and workspace settings.
Support and API docs
If a workflow fails and troubleshooting does not resolve it, contact BackgroundErase support with the operation name, the error message, whether the workflow used binary file input or an image URL, the input and output binary property names, and the destination node receiving the processed image.
