Endpoint
API Playground
Test the BackgroundErase API with your own image.
Use the playground to validate input modes, output formats, and request flags before wiring BackgroundErase into a production image workflow.
Desktop required
The API playground is available on desktop.
Open this page on a laptop or desktop to upload images, compare outputs, and copy generated API request examples.
How to use it
Treat this like a safe staging request.
The playground is meant for fast validation: choose the image source, adjust the same flags your backend can send, then copy the request shape into your integration once the output looks right.
Authentication
x-api-key
Use an API key from your account in server-side code. Keep keys out of browser and mobile clients.Default output
PNG
Transparent RGBA PNG is the default. Choose JPG or a background color when you need a flattened result.Good tests
What to try before production
- Compare PNG, JPG, and WebP outputs before choosing a production default.
- Try alpha mode when you need a mask for your own compositing pipeline.
- Use crop with product or catalog images where tight subject bounds matter.
- Use despill for green-screen or color-spill source images.
Ready to integrate?
Turn a playground pass into your first backend request.
Create an API key, keep it server-side, and reuse the same request fields you tested here for batch jobs, product tools, and internal automations.
Server-side key
Use the x-api-key header securely.
Multipart first
Start with image_file uploads.
Production docs
Add retries, storage, and monitoring.