withoutBG
Remove backgrounds in Python. Free locally. One line to switch to the Cloud API.
Same API for both paths: run open weights on your machine (private, offline, unlimited) or call the Cloud API (sharper edges on hair and fur, no local GPU). Built for scripts, notebooks, backends, and batch jobs.
See the results
Open Weights results → · Cloud API results → · Compare →
Three lines of Python
from withoutbg import WithoutBG
model = WithoutBG.open_weights()
model.remove_background("photo.jpg").save("result.png")
Returns a PIL Image in RGBA. Prefer PNG or WebP; JPEG drops transparency silently.
Install
uv add withoutbg
Don't have uv yet? It's a fast Python package manager from Astral. Install it once, then the command above.
Quick start
Local (Open Weights: free, private, offline):
from withoutbg import WithoutBG
model = WithoutBG.open_weights()
result = model.remove_background("input.jpg")
result.save("output.png")
First local run downloads ~1.5 GB of weights from Hugging Face (once; the BiRefNet branch is fetched the first time an image needs it). After that, everything stays on your machine.
Cloud (withoutBG API: best quality):
from withoutbg import WithoutBG
# Pass api_key here, or set WITHOUTBG_API_KEY in the environment
model = WithoutBG.api(api_key="sk_your_key")
result = model.remove_background("input.jpg")
result.save("output.png")
Batch (load once, process many):
from withoutbg import WithoutBG
model = WithoutBG.open_weights() # keep this object alive
images = ["photo1.jpg", "photo2.jpg", "photo3.jpg"]
results = model.remove_background_batch(images, output_dir="results/")
Recreating the model for every image reloads the weights each time. Don't do that in a loop.
Progress callback:
def on_progress(value: float) -> None:
print(f"{value * 100:.0f}%")
result = model.remove_background("photo.jpg", progress_callback=on_progress)
Runnable scripts live in examples/.
Choose your mode
Local (open_weights()) |
Cloud (api()) |
|
|---|---|---|
| Cost | Free forever | Pay per image |
| Quality | Good | Better (esp. hair, fur) |
| Privacy | Stays on your machine | Image sent to API |
| GPU required | No (CPU ONNX) | No |
| First-run setup | ~1.5 GB download, once | API key only |
| Best for | Offline, private, batch jobs | Products, occasional use |
Need offline or private processing? → Local
Processing a large batch? → Local (pay setup once, amortize across images)
Building a product? → Cloud (better quality, zero infra)
Occasional use, no setup tolerance? → Cloud
CLI
# Single image (local model)
withoutbg photo.jpg
withoutbg photo.jpg --output result.png
# Cloud API
export WITHOUTBG_API_KEY=sk_your_key
withoutbg photo.jpg --use-api
# JPEG with white background fill
withoutbg portrait.jpg --format jpg --quality 95
withoutbg --help
What you get
All methods return a PIL Image in RGBA mode:
result = model.remove_background("photo.jpg")
result.save("output.png") # keeps transparency
result.save("output.webp") # keeps transparency
result.save("output.jpg") # transparency dropped silently
Compositing example:
from PIL import Image
from withoutbg import WithoutBG
model = WithoutBG.open_weights()
fg = model.remove_background("subject.jpg")
bg = Image.open("background.jpg")
bg.paste(fg, (0, 0), fg) # alpha used as mask
bg.save("composite.png")
Configuration
| Environment variable | Effect |
|---|---|
WITHOUTBG_API_KEY |
API key for Cloud mode (alternative to api_key=) |
WITHOUTBG_MODEL_PATH |
Path to a local .onnx file (skips Hugging Face download) |
When using WITHOUTBG_MODEL_PATH, keep the sidecar metadata file (withoutbg-open-weights.onnx.json) next to the ONNX file.
Error handling
from withoutbg import WithoutBG, APIError, WithoutBGError
try:
model = WithoutBG.api()
result = model.remove_background("photo.jpg")
result.save("output.png")
except APIError as e:
print(f"API error: {e}")
except WithoutBGError as e:
print(f"Processing error: {e}")
Troubleshooting
Model download fails: Weights come from Hugging Face on first local run (~1.5 GB). Check your connection, or set WITHOUTBG_MODEL_PATH to a local copy.
Import error:
which python
uv pip list | grep withoutbg
uv add withoutbg
API key rejected: Get a key at withoutbg.com. Set export WITHOUTBG_API_KEY=sk_your_key.
Migrating from older names (WithoutBG.opensource(), ProAPI): see docs/MIGRATION.md.
More than Python
This package is the in-process path: embed withoutBG in your Python code or CLI. Same open-weights technology powers the rest of the ecosystem; pick the surface that matches your workflow:
| Surface | Choose when |
|---|---|
| Docker / self-host | You want an HTTP API or browser UI on your own server (CPU or NVIDIA GPU) |
| Mac app | You want a native desktop cutout tool, with an optional Local API for plugins and scripts |
| GIMP plugin | You edit in GIMP 3 and want a private, mask-first workflow via Mac Local API or Docker |
| Hugging Face · Space | You want to try a demo or download the ONNX weights directly |
| Cloud API | You need maximum quality without running inference yourself |
# Self-host the open-weights web app (CPU)
docker run --rm -p 8080:8080 withoutbg/withoutbg-openweights-v3-app-cpu
Model
The withoutBG Open Weights Model is an ONNX bundle hosted at withoutbg/withoutbg-openweights-onnx (version 10.8.0; the SDK pins the Hub revision). Built with DINOv3.
A trained router looks at each image and picks a branch:
- Fine strands, soft detail, transparency → the withoutBG matting model (Depth Anything V2 small depth + DINOv3 ConvNeXt-fused matting), trained and maintained by withoutBG.
- Hard opaque objects, flat scenes, vehicles → BiRefNet segmentation.
Only the selected branch runs, and its alpha is upsampled to the image's native resolution (up to 4096 px per side). To run offline, download the whole bundle and set WITHOUTBG_MODEL_PATH to withoutbg-open-weights.onnx inside it; the other graphs are read from the same folder.
Licensed under the withoutBG Open Model License (Apache 2.0 for withoutBG portions; Meta DINOv3 License for DINOv3 backbone weights; MIT for BiRefNet). See the model's LICENSE.
Development
uv sync --extra dev
make test-fast # fast unit tests
make quality # lint + format + type check
make test # full suite (downloads model on first run)
See CONTRIBUTING.md for the full guide.
License
This Python SDK is licensed under Apache License 2.0. See LICENSE.
The withoutBG Open Weights Model is a composite artifact with additional terms for embedded DINOv3 weights. See the withoutBG Open Model License, LICENSE-DINOv3, and NOTICE.
Third-party components
- DINOv3 (Meta): Meta DINOv3 License (backbone weights in the Open Weights Model)
- Depth Anything V2: Apache 2.0 (small variant; only the small variant is permissive)
- BiRefNet (ZhengPeng7): MIT (segmentation branch of the Open Weights Model)
See THIRD_PARTY_LICENSES.md for complete attribution.
Support
- Bugs / questions: GitHub Issues
- Commercial: contact@withoutbg.com
- Security: contact@withoutbg.com (see SECURITY.md)
Metadata
Release files for withoutbg 1.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| withoutbg-1.2.1.tar.gz | 301.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| withoutbg-1.2.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 332.3 kB
Release files / withoutbg-1.2.1.tar.gz
| Download URL | withoutbg-1.2.1.tar.gz |
|---|---|
| Size | 301.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
929b8e833ddfd4fe9934a9d597a0e8302233a54f1adecf6d3a287b12c2c5b8b1
|
|
BLAKE2b-256 checksum How to use checksums |
d1fd6a9c6f12bcc4a11026bb33422cac7d59c47c5f313e03c0dd60d0db075baf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 3, 2026.
Transparency logRelease files / withoutbg-1.2.1-py3-none-any.whl
| Download URL | withoutbg-1.2.1-py3-none-any.whl |
|---|---|
| Size | 30.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
75910e026e00fe2f204fd99dcea46ddc807246aa08097c104c7264693b1d25ec
|
|
BLAKE2b-256 checksum How to use checksums |
88b7c1a2b9095eab24fa23e3e1ca76c13c2df2872fb189c90935b431680aa6d0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 3, 2026.
Transparency log