Remove image backgrounds in Ruby
For Rails apps and background jobs, the multipart-post gem gives you a clean way to stream a file upload without hand-rolling the multipart body.
Install (gem)
gem install multipart-postRemove a background
require "net/http"
require "net/http/post/multipart"
url = URI("https://api.bgbuster.com/images/remove-background")
request = Net::HTTP::Post::Multipart.new url.path,
"input" => UploadIO.new(File.open("photo.jpg"), "image/jpeg", "photo.jpg"),
"format" => "png"
request["X-Api-Key"] = "your-api-key"
response = Net::HTTP.start(url.host, url.port, use_ssl: true) { |http| http.request(request) }
result = JSON.parse(response.body)
puts result["url"]The request is a multipart POST to https://api.bgbuster.com/images/remove-background, authenticated with your API key in the X-Api-Key header. Pass the image as a file (input) or as a public URL string.
By default the response is JSON with a temporary download url. That URL stays valid for 24 hours — download and store the image yourself if you need it longer.
Need more than a plain removal? POST /images/edit takes the same kind of request and chains background removal together with resize, rotate, flip, blur, brightness/contrast/saturation, and trim — in whatever order you list them.
| Field | Type | Required | Description |
|---|---|---|---|
| input | File or string | Yes | Image file or a public URL to fetch it from. |
| output | "url" or "raw" | No | Return a temporary download URL, or the transformed image bytes directly. Defaults to "url". |
| format | "png" or "webp" | No | Output image format. Defaults to "png". |
| trim | boolean | No | Trim empty transparent space around the result. |
Default (output=url)
{
"id": "image-id",
"url": "https://..."
}With output=raw, save the image bytes directly instead of following a URL
require "net/http"
require "net/http/post/multipart"
url = URI("https://api.bgbuster.com/images/remove-background")
request = Net::HTTP::Post::Multipart.new url.path,
"input" => UploadIO.new(File.open("photo.jpg"), "image/jpeg", "photo.jpg"),
"format" => "png",
"output" => "raw"
request["X-Api-Key"] = "your-api-key"
response = Net::HTTP.start(url.host, url.port, use_ssl: true) { |http| http.request(request) }
File.binwrite("result.png", response.body)| Status | Code | Meaning |
|---|---|---|
| 400 | IMAGE_TOO_LARGE | The input image exceeds the size limit. |
| 400 | IMAGE_DECODE_ERROR | The input file couldn't be decoded as an image. |
| 400 | INVALID_IMAGE_URL | The URL passed as input didn't return image content. |
| 400 | UPSTREAM_ERROR | The input URL couldn't be fetched. |
| 401 | UNAUTHORIZED | The API key is missing or invalid. |
| 402 | INSUFFICIENT_BALANCE | Your account is out of credits. |
| 403 | IMAGE_FORBIDDEN | The source CDN blocked the request for the input URL. |
| 429 | TOO_MANY_REQUESTS | Rate limit exceeded — retry after a short delay. |
| 500 | IMAGE_TRANSFORMATION_ERROR | The background removal step failed unexpectedly. |
- 1
Sign up with an email or a social login — no credit card required.
- 2
Buy a credit pack. Credits never expire, and you'll need a balance before the API accepts requests.
- 3
From the dashboard, go to API Keys and click Create API key.
- 4
Authenticate your requests
Send the key in the X-Api-Key header on every request to api.bgbuster.com.