FileSpin icon

FileSpin

Upload, tag, resize, and share digital assets with FileSpin DAM

Actions17

Addon → Remove Background

AI-generated

Summary

Remove background from an image asset.

Inputs

  • addonAssetId (required) — The 32-character asset ID of the image to process.
  • bgSaveResultAs — Choose whether to create a new asset (returns new_asset_id) or return the processed image only.
  • bgInheritMetadata — If saving a new asset, copy metadata from the original asset.

Output shape

A single JSON object representing the background removal result, always containing the original assetId and typically including new_asset_id or processed image data when Save Result As = add_new_asset.

The operation returns a single record; errors are thrown rather than wrapped. When Save Result As is set to 'add_new_asset', the response includes new_asset_id, otherwise it returns the processed image metadata or URL.

Examples

Example 1: Remove background and save as new asset with inherited metadata.

addonAssetId=123e4567-e89b-12d3-a456-426614174000, bgSaveResultAs=add_new_asset, bgInheritMetadata=true

Example 2: Remove background and return processed image only.

addonAssetId=123e4567-e89b-12d3-a456-426614174000, bgSaveResultAs=return_image

Links

Discussion