Developer API · v1
Background removal API
Remove backgrounds programmatically. One authenticated POST request returns a hosted transparent PNG. Powered by the same BiRefNet engine as the web app.
Key-based auth
Bearer sk_live_… keys, hashed at rest, revocable anytime.
Quotas & limits
Monthly quota + per-minute rate limits enforced per key.
1 credit / call
Each successful removal deducts one credit from your plan.
Your keys
Generate and manage keys tied to your subscription.
Log in to generate and manage your API keys.
Log inRemove background
POSThttps://api.gonebg.com/v1/remove
Request
cURL
curl -X POST "https://api.gonebg.com/v1/remove" \
-H "Authorization: Bearer sk_live_YOUR_API_KEY" \
-F "image=@product.jpg" \
-F "hd=true"Response 200
JSON
{
"id": "img_123",
"download_url": "https://cdn.gonebg.com/abc123.png",
"credits_used": 1,
"credits_remaining": 299
}| Parameter | Type | Description |
|---|---|---|
| image | file | Multipart image file to process (JPG/PNG/WebP). |
| image_url | string | Alternative to image: a public URL or data URI. |
| hd | boolean | Optional. Request full-resolution output. |
Errors
| Status | Code | Meaning |
|---|---|---|
| 401 | invalid_api_key | Missing, malformed, or revoked API key. |
| 402 | no_credits | Monthly quota exhausted for this billing cycle. |
| 402 | no_api_access | The plan tied to the key has no API access. |
| 422 | missing_image | No image file or image_url provided. |
| 429 | rate_limited | Per-minute rate limit exceeded (see plan table). |
Plans & rate limits
| Plan | API access | Monthly | Rate limit |
|---|---|---|---|
| Hobby $9 | No | — | — |
| Etsy Pro $19 | Yes | 300 req/mo | 10 req/min |
| Agency $49 | Yes | 1000 req/mo | 60 req/min |