DOCUMENTATION: Vehicle Background Removal API

Background Remover (BGR) API: Overview

The Background Remover (BGR) API, utilizing advanced AI, enables users to remove the background on any vehicle image provided. The output of this API can serve as a valuable complement to the information provided in a car report.

To access the API for the BGR images, you must have an API-enabled account, which will provide you with an API Key. This Key allows your application to send data transfer requests to the VinAudit API servers.

Supported Methods of Image Input

Passing Image URL: Requires a publicly accessible URL pointing to the image. This method is convenient for images already hosted online.
Passing Image File: Allows the direct upload of image files (jpg, png) from the client’s system. This method is suitable for images stored locally on the user’s device.
Passing Base64 Image: Involves sending the image as a Base64-encoded string. This method is beneficial for applications that process images in a format that can be easily encoded and transmitted within JSON structures.

Background Manipulation Options

White Background: Replaces the original background with a plain white background.
Transparent Background: Makes the original background transparent.
Custom Background: Allows the user to upload a custom background image that replaces the original background. For operations requiring a custom background, the user must pass a publicly accessible URL or upload a file for the custom background.
Generative Background: Allows the user to add a background based on the prompt provided. To use the generative background feature, users can pass the value of generative_background to the prompt key.

Note: Output will also include ‘window correction,’ which will remove any objects in the background that appear through a window, such as a building, trees, other vehicles, etc.

API Endpoints

For image URLs: http://api-bgremover.vinaudit.com/remove-bg-url
For image file uploads: http://api-bgremover.vinaudit.com/remove-bg-upload
For Base64 encoded images: http://api-bgremover.vinaudit.com/remove-bg-base64

Documentation

API-EndPoint 1 – Through a URL

`http://api-bgremover.vinaudit.com/remove-bg-url`

Parameter	Description	Optional	Example
image_url	URL of vehicle, must be publicly accessible.	No	https://hips.hearstapps.com/hmg-prod/images/p90475606-highres-rolls-royce-phantom-1677268219.jpg
key	Your VinAudit API key	No	YOUR_KEY
background	white or transparent or custom (uploaded image)	Yes	white
background_url	Public accessible URL of custom background	Yes	https://img.freepik.com/free-photo/vintage-grunge-blue-concrete-texture-studio-wall-background-with-vignette_1258-28395.jpg
center_output	Center the output or not	Yes	true
crop_output	Crop the output or not	Yes	true
shadow	Add shadow to output or not	Yes	true
custom_background	Use this to pass a local system file for a custom background.	Yes	open(‘custom_background_sample.jpg’, ‘rb’)

Response Elements

Element	Description	Example
output_url	The API returns a URL of the output image which users can open on any browser.	http://api-bgremover.vinaudit.com/getImage/843d1b1f802599454bbca9a95a2601a7b8c.png
success	Whether execution was successful or not. One of: true: Background is successfully removed false: An error occurred during the execution	true
message	This will be present in case any error occurs. It will contain a brief about the cause of the error.	“Invalid Key”

Documentation

API-EndPoint 2 – Upload an Image Directly

`http://api-bgremover.vinaudit.com/remove-bg-upload`

Parameter	Description	Optional	Example
image_file	Image file (PNG or JPG)	No
key	Your VinAudit API key	No	YOUR_KEY
background	white or transparent or custom (uploaded image)	Yes	white
background_url	Public accessible URL of custom background	Yes	https://img.freepik.com/free-photo/vintage-grunge-blue-concrete-texture-studio-wall-background-with-vignette_1258-28395.jpg
center_output	Center the output or not	Yes	true
crop_output	Crop the output or not	Yes	true
shadow	Add shadow to output or not	Yes	true
custom_background	Use this to pass a local system file for a custom background.	Yes	open(‘custom_background_sample.jpg’, ‘rb’)

Response Elements

Element	Description	Example
output_url	The API returns a URL of the output image which users can open on any browser.	http://api-bgremover.vinaudit.com/getImage/843d1b1f802599454bbca9a95a2601a7b8c.png
success	Whether execution was successful or not. One of: true: Background is successfully removed false: An error occurred during the execution	true
message	This will be present in case any error occurs. It will contain a brief about the cause of the error.	“Invalid Key”

Documentation

API-EndPoint 3 – Through Base64 of an Image

`http://api-bgremover.vinaudit.com/remove-bg-base64`

Parameter	Description	Optional	Example
image_data	Base64 encoded string of vehicle image	No	data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAzIAAAJpCAYAAAB2CwetAAAA…
key	Your VinAudit API key	No	YOUR_KEY
background	white or transparent or custom (uploaded image)	Yes	white
background_url	Public accessible URL of custom background	Yes	https://img.freepik.com/free-photo/vintage-grunge-blue-concrete-texture-studio-wall-background-with-vignette_1258-28395.jpg
center_output	Center the output or not	Yes	true
crop_output	Crop the output or not	Yes	true
shadow	Add shadow to output or not	Yes	true
custom_background	Use this to pass a local system file for a custom background.	Yes	open(‘custom_background_sample.jpg’, ‘rb’)

Response Elements

Element	Description	Example
output_url	The API returns a URL of the output image which users can open on any browser.	http://api-bgremover.vinaudit.com/getImage/843d1b1f802599454bbca9a95a2601a7b8c.png
success	Whether execution was successful or not. One of: true: Background is successfully removed false: An error occurred during the execution	true
message	This will be present in case any error occurs. It will contain a brief about the cause of the error.	“Invalid Key”

Brief on Image Processing Options

background: It can take "white_background", "custom_background", & "transparent_background" to modify the background of the final output.
background_url: Publicly accessible URL of a custom background.
center_output: It can take "true" or "false". It centers the position of the output.
crop_output: It can take "true" or "false". Crops the final output to fit the new background more closely. Only one of the parameters "crop_output" or "center_output" can be set to "true".
shadow: It can take "true" or "false". It allows users to add a shadow to the output, giving it a more natural and integrated appearance with the new background.
custom_background: You can pass a file from your local system in byte format as a custom background. If both "background_url" and "custom_background" are provided, preference will be given to "background_url".

Python Code Snippets for Sending API Request

For Image URL API

import requests
import json

url = "https://stimg.cardekho.com/images/carexteriorimages/930x620/Rolls-Royce/Spectre/11100/1705661590820/front-left-side-47.jpg"
req_json = {
    "image_url": url,   ## URL Must be publicly accessible
    "key": "YOUR_KEY",  ## KEY to access API
    "background": "white_background",  ## It can take "white_background", "custom_background" & "transparent_background"
    "center_output": False,  ## Whether to center the output image
    "shadow": True,  ## Whether to have a shadow in the resulting image
    "crop_output": False,  ## Whether to crop the final output
}
response = requests.post(api_url, data=req_json)
print(response.json())

For Image File API

import requests
import json

req_json = {
    "key": "YOUR_KEY",  ## KEY to access API
    "background": "white_background",  ## It can take "white_background", "custom_background" &
    "transparent_background" "background_url": "",
    "center_output": False,  ## This will center the output image
    "shadow": True,  ## Whether to have a shadow in the resulting image or not
    "crop_output": False,  ## Only one of 'center_output' or 'crop_output' can be used
}

files = {
    "image_file": open("/PATH/TO/TEST_IMAGE.jpg", "rb")
}  ## Assuming your local file name is test.jpg

api_file_url = "http://api-bgremover.vinaudit.com/remove-bg-upload"
response = requests.post(api_file_url, data=req_json, files=files)
print(response.text)

Give a Custom Background

import requests
import json

url = "https://stimg.cardekho.com/images/carexteriorimages/930x620/Rolls-Royce/Rolls-Royce-Phantom/7783/1587206758888/front-left-side-47.jpg"
req_json = {
    "image_url": url,   ## URL Must be publicly accessible
    "key": "YOUR_KEY",  ## KEY to access API
    "background": "custom_background",  ## It can take "white_background", "custom_background" &
    "transparent_background"
    "background_url": "http://api-bgremover.vinaudit.com/getImage/5c629c7b5a66e13b5b1426a0f1acb0308dc.png",  ## URL of custom background
    "center_output": False,  ## This will center the output image
    "shadow": True,  ## Whether to have a shadow in the resulting image or not
    "crop_output": False,  ## Only one of 'center_output' or 'crop_output' can be used
}

api_url = "http://api-bgremover.vinaudit.com/remove-bg-url"
response = requests.post(api_url, data=req_json)
print(response.json())

For Base64 Encoded String API

import requests
import json
import base64

file_name = "test_image2.jpg"   ## Assuming your local file name is test.jpg
with open(file_name, "rb") as file:
    encoded_string = base64.b64encode(file.read())

req_json = {
    "image_data": encoded_string,   ## Base64 Encoded string of source image
    "key": "YOUR_KEY",  ## KEY to access API
    "background": "white_background",  ## Can be "white_background", "custom_background" & "transparent_background"
    "background_url": "https://img.freepik.com/free-photo/vintage-grunge-blue-concrete-texture-studio-wall-background-with-vignette_1258-28395.jpg",
    "center_output": False,  ## This will center the output image
    "shadow": True,  ## Whether to have a shadow in the resulting image or not
    "crop_output": False,  ## Only one of 'center_output' or 'crop_output' can be used
}

api_base64_url = "http://api-bgremover.vinaudit.com/remove-bg-base64"
response = requests.post(api_base64_url, data=req_json)
print(response.json())

For Using Local File for Custom Background

import requests
import json
import base64

req_json = {
    "key": "YOUR_KEY",  ## KEY to access API
    "background": "custom_background",  ## Can be "white_background", "custom_background" & "transparent_background"
    "center_output": False,  ## This will center the output image
    "shadow": True,  ## Whether to have a shadow in the resulting image or not
    "crop_output": False,  ## Only one of 'center_output' or 'crop_output' can be used
}

files = {
    "image_file": open("/home/PATH/TO/LOCAL/FILE/test_image2.jpg", "rb"),
    "custom_background": open(
        "/home/PATH/TO/LOCAL/FILE/custom_background_sample.jpg", "rb"
    ),
}

api_url = "http://api-bgremover.vinaudit.com/remove-bg-upload"
response = requests.post(api_url, files=files, data=req_json)
print(response.text)

Saving Output

import requests
import json

url = "https://stimg.cardekho.com/images/carexteriorimages/930x620/Rolls-Royce/Spectre/11100/1705661590820/front-left-side-47.jpg"
req_json = {
    "image_url": url,   ## URL Must be publicly accessible
    "key": "YOUR_KEY",  ## KEY to access API
    "background": "white_background",  ## Can be "white_background", "custom_background" &
    "transparent_background"
    "center_output": False,  ## Whether to center the output image
    "shadow": True,  ## Whether to have a shadow in the resulting image or not
    "crop_output": False,  ## Only one of 'center_output' or 'crop_output' can be used
}

api_url = "http://api-bgremover.vinaudit.com/remove-bg-url"
response = requests.post(api_url, data=req_json)
print(response.json())

saving_file_name = "output_sample.png"   ## Set saving file name
api_decoded_response = json.loads(response.content.decode("utf-8"))
api_output_url = api_decoded_response["output_url"]
output_image = requests.get(api_output_url)

with open(f"{saving_file_name}", "wb") as f:
    f.write(output_image.content)

DOCUMENTATION: Vehicle Background Removal API

Background Remover (BGR) API: Overview

Supported Methods of Image Input

Background Manipulation Options

API Endpoints

Brief on Image Processing Options

Python Code Snippets for Sending API Request

The most comprehensive Automotive Data & Analytics

SERVICES

RESOURCES

CUSTOMERS

ABOUT US

VinAudit Canada Inc.