Remove
Tool for the remove API.
- Base URL:
https://api.remove.bg/v1.0 - Auth:
header:X-API-Key(pass your key via theapiKeyinput)
Operations
get_account— GET /account — Fetch credit balance and free API calls.post_improve— POST /improve — Submit an image to the remove.bg Improvement program- Contribute an image that
post_removebg— POST /removebg — Remove the background of an image
Inputs
apiKey— your remove API keyoperation— one of the operations above- path parameters when an operation's path contains
{...} query— optional JSON object of query paramsbody— JSON object for create/update ops
Example
operation: get_account
apiKey: <your key>
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
erroroperationresultstatus
Input Properties
Every property this tool accepts, from its own tool.iml.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
apiKey |
string | yes | — | DEPRECATED — bind an API Key credential to the task with credentialName instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change. |
operation |
string | yes | — | One of: get_account, post_improve, post_removebg |
body |
string | no | — | Request body as a JSON object string (for create/update operations). |
query |
string | no | — | Query-string parameters as a JSON object string, e.g. {"limit": 50}. Parsed and url-encoded onto the request. |