Remove.bg
Overview
Section titled “Overview”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.
- Official website: https://www.remove.bg/
- Composio documentation: docs.composio.dev/toolkits/remove_bg
Authentication
Section titled “Authentication”This tool uses an API key (API_KEY) to connect.
You will need the following fields:
| Field | Required | Description |
|---|---|---|
api_key | Yes | API key from your Remove.bg account, used to authenticate all requests. |
How to get credentials
Section titled “How to get credentials”- Go to www.remove.bg/users/sign_up and create a free account.
- Confirm your email to activate the account.
- Log in and navigate to www.remove.bg/api.
- Under API Keys, click Get API Key.
- Copy the generated key — this is the value to use in the
api_keyfield when connecting in SquadOS.
How to connect in SquadOS
Section titled “How to connect in SquadOS”- Go to Tools in the side menu (
/admin/tools). - Open the Available tab and search for
Remove.bg. - Click the card to open the details modal and hit Connect.
- You’re taken to the secure connection page hosted by Composio, where you enter the API key obtained above.
- 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.)
Available actions
Section titled “Available actions”Remove Background
Section titled “Remove Background”REMOVE_BG
Tool to remove background from an image. Use when you need a transparent or custom background for product or profile photos.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
roi | string | No | Region of interest in pixels as left,top,width,height. |
crop | boolean | No | Crop to ROI if true. |
size | string | No | Output image size. One of auto, preview, full. |
type | string | No | Image category. One of auto, person, product. |
scale | string | No | Scales 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. |
format | string | No | Output image format. One of auto, png, jpg. |
bg_color | string | No | Hex color #RRGGBB to fill background instead of transparency. |
channels | string | No | Output channels. Only rgba supported. |
position | string | No | Position of subject: center or original. |
image_url | string | No | URL of the image to process. Required if image_file is not provided. |
image_file | string | No | Raw bytes of the image file to upload (multipart/form-data). Required if image_url is not provided. |
bg_image_url | string | No | Background image URL to composite behind subject. |
bg_image_file | string | No | Background image file bytes to composite behind subject. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Get Account
Section titled “Get Account”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.
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Submit Improvement
Section titled “Submit Improvement”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.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
tag | string | No | Tag to group related images together. Images with the same tag are grouped. |
image_url | string | No | URL 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_file | object | No | Image file to upload. Required if image_file_b64 and image_url are not provided. Only one image source parameter can be specified. |
image_file_b64 | string | No | Base64-encoded image file string. Required if image_file and image_url are not provided. Only one image source parameter can be specified. |
image_filename | string | No | Filename of the image. If not provided, it will be autodetected from the submitted data. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |