Remove Background Tool
remove_backgroundRemove the background from an already-uploaded image file (a hashid from
create_upload), returning a transparent PNG. This is FREE and only needs an account,
no subscription.
To use a local file: call create_upload, PUT the bytes to the returned upload_url,
then pass that id here as file. Do NOT call complete_upload (that starts the paid
clip pipeline); this free tool reads the uploaded file directly.
Processing is ASYNCHRONOUS: this returns a tool_job hashid and status: "queued".
Poll get_tool_job_status with that tool_job until it reports completed, then it
returns the downloadable PNG URL. Free usage is rate-limited per day with a per-file
size cap; a clear error explains how to lift a limit.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| file | Yes | The uploaded image id (hashid) from create_upload (no complete_upload needed). |