Compatibility at a glance
The bgfree.app endpoint is `POST https://api.bgfree.app/v1.0/removebg`; authenticate with `X-Api-Key` using a bgfree.app key. Supported image input forms are multipart `image_file` or `image`, `image_url`, and `image_base64`. Supported options are `size`, `format`, and `bg_color`. The response is binary image data, with request and image metadata headers.
Replace endpoint and key
curl -X POST \
https://api.bgfree.app/v1.0/removebg \
-H "X-Api-Key: YOUR_BGF_KEY" \
-F "image_file=@photo.jpg" \
-o result.png
Create a key in the bgfree.app dashboard and store it as a server-side secret. Do not reuse or expose a key from another service.
Check unsupported fields
The implementation rejects unknown request fields with `unsupported_parameter`. Fields such as `crop`, `position`, `type`, `scale`, and source-image URL response modes are not supported by the current API contract. Inspect your actual requests and remove or redesign dependencies on unsupported behavior before migration.
Test errors, credits, and output
A successful image request charges one image. Responses can include JSON errors for authentication, insufficient balance, invalid images, size limits, rate limits, concurrency limits, or processing failures. Check status before reading the body as an image. Use a staging key, representative images, and deliberate error cases before shifting production traffic.
Migration checklist
Create a bgfree.app account and key; switch to the bgfree.app endpoint; map only supported fields; update response parsing for binary output and JSON errors; review rate and concurrency limits and image balance; test representative images and failure paths; then migrate traffic gradually with monitoring. See the full compatibility documentation.