Skip to content

Remove.bg

Remove.bg

Remove.bg is an API that uses artificial intelligence to automatically remove backgrounds from images. With the integration in SquadOS, your agents can process product photos, portraits, and any image, delivering results with a transparent or replaced background in seconds.

This tool uses an API key (API_KEY) to connect.

You will need the following fields:

FieldRequiredDescription
api_keyYesAPI key from your Remove.bg account, used to authenticate all requests.
  1. Go to www.remove.bg/users/sign_up and create a free account.
  2. Confirm your email to activate the account.
  3. Log in and navigate to www.remove.bg/api.
  4. Under API Keys, click Get API Key.
  5. Copy the generated key — this is the value to use in the api_key field when connecting in SquadOS.
  1. Go to Tools in the side menu (/admin/tools).
  2. Open the Available tab and search for Remove.bg.
  3. Click the card to open the details modal and hit Connect.
  4. You’re taken to the secure connection page hosted by Composio, where you enter the API key obtained above.
  5. Once done, you’re sent back to SquadOS with the account connected and the tool available to your agents. (Connection-flow details in Organization Tools.)

REMOVE_BG

Tool to remove background from an image. Use when you need a transparent or custom background for product or profile photos.

NameTypeRequiredDescription
roistringNoRegion of interest in pixels as left,top,width,height.
cropbooleanNoCrop to ROI if true.
sizestringNoOutput image size. One of auto, preview, full.
typestringNoImage category. One of auto, person, product.
scalestringNoScales the subject image as a percentage of the original size, formatted as <int>% between 10% and 100% (e.g., 50%). Use 100% or omit to keep the original size.
formatstringNoOutput image format. One of auto, png, jpg.
bg_colorstringNoHex color #RRGGBB to fill background instead of transparency.
channelsstringNoOutput channels. Only rgba supported.
positionstringNoPosition of subject: center or original.
image_urlstringNoURL of the image to process. Required if image_file is not provided.
image_filestringNoRaw bytes of the image file to upload (multipart/form-data). Required if image_url is not provided.
bg_image_urlstringNoBackground image URL to composite behind subject.
bg_image_filestringNoBackground image file bytes to composite behind subject.
NameTypeRequiredDescription
datastringYesData from the action execution.
errorstringNoError if any occurred during the execution of the action.
successfulbooleanYesWhether or not the action execution was successful.

REMOVE_BG_GET_ACCOUNT

Tool to retrieve account information, including current credit balance. Use when you need to know your remove.bg account’s credit and usage details.

NameTypeRequiredDescription
datastringYesData from the action execution.
errorstringNoError if any occurred during the execution of the action.
successfulbooleanYesWhether or not the action execution was successful.

REMOVE_BG_SUBMIT_IMPROVEMENT

Tool to submit an image to the remove.bg Improvement program. Use when you want to contribute images that remove.bg cannot process properly to help improve the AI. By submitting images you agree to the Improvement Program Conditions. Limited to 100 files per day, max 22MB file size, up to 50 megapixels resolution.

NameTypeRequiredDescription
tagstringNoTag to group related images together. Images with the same tag are grouped.
image_urlstringNoURL of the image to submit. Required if image_file and image_file_b64 are not provided. Only one image source parameter can be specified.
image_fileobjectNoImage file to upload. Required if image_file_b64 and image_url are not provided. Only one image source parameter can be specified.
image_file_b64stringNoBase64-encoded image file string. Required if image_file and image_url are not provided. Only one image source parameter can be specified.
image_filenamestringNoFilename of the image. If not provided, it will be autodetected from the submitted data.
NameTypeRequiredDescription
datastringYesData from the action execution.
errorstringNoError if any occurred during the execution of the action.
successfulbooleanYesWhether or not the action execution was successful.