ByeBG - Free Online Background Remover & Transparent Image Maker

Background Removal API Documentation Get API Key

This API allows developers to remove backgrounds from images programmatically.

Base URL

https://byebg.com/api/v1

Authentication

This API uses Bearer token authentication. Include your API key in the Authorization header of your requests: Authorization: Bearer YOUR_API_KEY

Required Headers

In addition to the Authorization header, you must include the following header in all API requests:

Accept: application/json

This header ensures that the API returns responses in JSON format.

Endpoints

Remove Background

Remove the background from an uploaded image.

URL: /remove-background
Method: POST
Content-Type: multipart/form-data

Request Parameters

Parameter	Type	Required	Description
image	File	Yes	The image file to process. Must be less than 5MB.

Response

Success Response (200 OK)

{
  "message": "Background removed successfully",
  "preview_url": "https://byebg.com/storage/images/preview/abcdef123456.png",
  "hd_url": "https://byebg.com/storage/images/hd/abcdef123456.png",
  "image_id": 12345
}

Example Usage

curl -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: multipart/form-data" \
  -F "image=@/path/to/your/image.jpg" \
  https://byebg.com/api/v1/remove-background

$client = new \GuzzleHttp\Client();
$response = $client->request('POST', 'https://byebg.com/api/v1/remove-background', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
    'multipart' => [
        [
            'name' => 'image',
            'contents' => fopen('/path/to/your/image.jpg', 'r')
        ]
    ]
]);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests

url = "https://byebg.com/api/v1/remove-background"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json"
}
files = {
    "image": open("/path/to/your/image.jpg", "rb")
}

response = requests.post(url, headers=headers, files=files)
print(response.json())

const form = new FormData();
form.append("image", imageFile);  // imageFile is your File object

fetch("https://byebg.com/api/v1/remove-background", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json"
  },
  body: form
})
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));

require 'net/http'
require 'uri'
require 'json'

uri = URI.parse("https://byebg.com/api/v1/remove-background")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer YOUR_API_KEY"
request["Accept"] = "application/json"
request.set_form([["image", File.open("/path/to/your/image.jpg")]], "multipart/form-data")

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts JSON.parse(response.body)