Background Removal API

Check out our sample code

Remove background from image file

Environment

//for full implementation guide please follow the link https://github.com/slazzercom/slazzer-api-implementation-kotlin-sample
private var API_KEY:String = "YOUR_SLAZZER_API_KEY"

public static String BASE_URL = "https://api.slazzer.com/";
public static Retrofit getRetrofit() {
    return new Retrofit.Builder()
            .baseUrl(AppConfig.BASE_URL)
            .addConverterFactory(GsonConverterFactory.create())
            .build();
}

@Multipart
@POST("v2.0/remove_image_background")
Call<ResponseBody> upload(
        @Header("API-KEY") String authorization,
        @PartMap Map<String, RequestBody> map
);

private fun uploadFile(inputImagePath:String?) {

if (inputImagePath == null || inputImagePath == "") {
        Toast.makeText(this, "Please select an image", Toast.LENGTH_LONG).show()
        return
    } else {
        showpDialog()
        val map = HashMap<String, RequestBody>()
        val file = File(inputImagePath)
        val requestBody = RequestBody.create(MediaType.parse("*/*"), file)
        map.put("source_image_file\"; filename=\"" + file.name + "\"", requestBody)
        val getResponse = AppConfig.getRetrofit().create(ApiConfig::class.java)
        val call = getResponse.upload(API_KEY, map)
        call.enqueue(object : Callback<ResponseBody> {
            override fun onResponse(
                call: Call<ResponseBody>,
                response: Response<ResponseBody>
            ) {
                if (response.isSuccessful) {
                    if (response.body() != null) {
                        hidepDialog()
                        try {
                            val outputImageFile: File = File(this@ImageActivity.cacheDir,""+System.currentTimeMillis()+"opt-put-results.png")
                            val sink: BufferedSink = Okio.buffer(Okio.sink(outputImageFile))
                            sink.writeAll(response.body().source())
                            sink.close()

Glide.with(this@ImageActivity).load(outputImageFile).into(imageView)

} catch (ex: Exception) {
                            print(ex.toString())
                        }
                    }
                } else {
                    hidepDialog()
                    Toast.makeText(applicationContext, "Unable to upload image", Toast.LENGTH_SHORT).show()
                }
            }

override fun onFailure(call: Call<ResponseBody>, t: Throwable) {
                hidepDialog()
            }
        })
    }
}

using System;
using System.IO;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Net;
using System.Net.Http;

namespace SwazzerCSharp
{
    //
    class Program
    {
        const string YOUR_API_KEY = "YOUR_SLAZZER_API_KEY";

static void Main(string[] args)
        {
            ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12 | SecurityProtocolType.Tls11;
            ServicePointManager.Expect100Continue = false;
            string jpegFileName = args[0];

using (var client = new HttpClient())
            {
                using (var formData = new MultipartFormDataContent())
                {
                    formData.Headers.Add("API-KEY", YOUR_API_KEY);
                    formData.Add(new ByteArrayContent(File.ReadAllBytes(jpegFileName)), "source_image_file", "file.jpg");
                    var response = client.PostAsync("https://api.slazzer.com/v2.0/remove_image_background", formData).Result;

if (response.IsSuccessStatusCode)
                    {
                        FileStream fileStream = new FileStream("no-bg.png", FileMode.Create, FileAccess.Write, FileShare.None);
                        response.Content.CopyToAsync(fileStream).ContinueWith((copyTask) => { fileStream.Close(); });
                    }
                    else
                    {
                        Console.WriteLine("Error: " + response.Content.ReadAsStringAsync().Result);
                    }
                }
            }
        }
    }
}

//use org.apache.httpcomponents

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.ClientProtocolException;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.mime.MultipartEntityBuilder;
import org.apache.http.impl.client.HttpClientBuilder;

public class App {
    public static void main(String[] args) throws ClientProtocolException, IOException {
        HttpClient httpClient = HttpClientBuilder.create().build();
        HttpEntity entity = MultipartEntityBuilder.create()
        .addBinaryBody("source_image_file", new File("YOUR_IMAGE_PAH"))
        .build();

HttpPost httpPost = new HttpPost("https://api.slazzer.com/v2.0/remove_image_background");
        httpPost.setHeader("API-KEY", "YOUR_SLAZZER_API_KEY");
        httpPost.setEntity(entity);
        HttpResponse response = httpClient.execute(httpPost);
        HttpEntity result = response.getEntity();
        InputStream inputStream = result.getContent();
        @SuppressWarnings("resource")
        OutputStream outputStream = new FileOutputStream("output.png");
        byte[] buffer = new byte[1024];
        int bytesRead;
        while((bytesRead = inputStream.read(buffer)) !=-1){
        outputStream.write(buffer, 0, bytesRead);
    }
    inputStream.close();
    outputStream.flush();
    }
}

//MARK: Api Calling
- (void) callsendImageAPI:(UIImage*)image {
    NSMutableURLRequest * request = [[NSMutableURLRequest alloc] initWithURL:[NSURL URLWithString:[NSString stringWithFormat:@"https://api.slazzer.com/v2.0/remove_image_background"]]];
    NSString * boundary = @"----WebKitFormBoundary7MA4YWxkTrZu0gW";

NSDictionary *headers = @{
        @"API-KEY": @"YOUR_API_KEY_HERE"
    };

[request setAllHTTPHeaderFields:headers];

NSMutableData * body = [NSMutableData alloc];
    NSData * torrentFileContents = UIImageJPEGRepresentation(image, 0.8);

[request setHTTPMethod:@"POST"];
    [request addValue:[NSString stringWithFormat:@"multipart/form-data; boundary=%@", boundary] forHTTPHeaderField:@"Content-Type"];

[body appendData:[[NSString stringWithFormat:@"--%@\r\n", boundary] dataUsingEncoding:NSUTF8StringEncoding]];
    [body appendData:[[NSString stringWithFormat:@"Content-Disposition: form-data; name=\"source_image_file\"; filename=\"%@\"\r\n", @"image"] dataUsingEncoding:NSUTF8StringEncoding]];
    [body appendData:[[NSString stringWithFormat:@"Content-Type: %@\r\n\r\n", @"application/x-bittorrent"] dataUsingEncoding:NSUTF8StringEncoding]];
    [body appendData:[NSData dataWithData:torrentFileContents]];
    [body appendData:[[NSString stringWithFormat:@"\r\n--%@--\r\n", boundary] dataUsingEncoding:NSUTF8StringEncoding]];

[request setHTTPBody:body];

NSURLSession *session = [NSURLSession sharedSession];
    NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
                                                completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
        if (error) {
            NSLog(@"%@", error);
        } else {
//            NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
//            NSError *parseError = nil;
            if (data != nil) {
                UIImage *img = [UIImage imageWithData:data];
                dispatch_async(dispatch_get_main_queue(), ^{
                    self.outputImage.image = img;
                });
            }
//            NSDictionary *responseDictionary = [NSJSONSerialization JSONObjectWithData:data options:0 error:&parseError];
//            NSLog(@"%@",responseDictionary);
        }
    }];
    [dataTask resume];
}

SLAZZER - SDK

Check out the official android library

Check out the official android libraryhere

Output Formats

Easily request any one of the 2 formats via our format parameter

Format	Resolution
png	Upto 10 MP , Ex - 3872 x 2592
jpg	Upto 25 MP , Ex - 6250 x 4000

*Please note that PNG images above 10 megapixels are not supported by default. If you do not require transparency we recommend using the JPG format.

API Reference

Server URL:https://api.slazzer.com/v2.0

Request Body:multipart/form-data

Method:POST

API:/remove_image_background

Authorization

API-KEY
string

Your API key

Parameters Request body

source_image_file
string($binary)

Source image file. Support only PNG, JPG, JPEG.

*** use only one source_image_ parameters at a time
source_image_url
string

Source image url. Support only PNG, JPG, JPEG.

*** use only one source_image_ parameters at a time
source_image_base64
string

Source image base64 format. Support only PNG, JPG, JPEG.

*** use only one source_image_parameters at a time
bg_image_file
string($binary)

This binary image file will be placed as a background of the output binary image. This image will be resized according to the output image aspect ratio. supported bg_image_file formats are `png`, `jpg`, `jpeg`.

*** use only one bg_parameters
bg_image_url
string

This image from the url will be placed as a background of the output binary image. This image will be resized according to the output image aspect ratio. supported bg_image_url formats are `png`, `jpg`, `jpeg`.

*** use only one bg_parameters
bg_image_base64
string

This image from the base64 string will be placed as a background of the output binary image. This image will be resized according to the output image aspect ratio. supported bg_image_base64 formats are `png`, `jpg`, `jpeg`.

*** use only one bg_parameters
bg_color_code
string

Output with solid background color. Has to be HEX color code. (e.g. #72E4B3, #B3D472).

*** Please Note: Add '#' before color code.

*** use only one bg_parameters
format
string

Output image format. Default value `png`. Otherwise, `jpg` for JPG format (no transparency) and `png` for PNG format. `png` format support alpha transparency. "zip" for ZIP format, contains color image and alpha matte image.
crop
boolean

Default value: false. It will crop all extra transparent pixels
crop_margin
int

This parameter only work when crop applied (crop=True). Default value of this parameter is 0px. it supports input value in the following ways

Ex. 20px - create margin all around the subject.
Ex. 12% - create margin all around the subject with respect to the subject size.
Ex. 10px,20px - create 10px margin left and right side, 20px margin top and bottom side.
Ex. 10%,20% - create 10% margin left and right side, 20% margin top and bottom side with respect to the subject size.
Ex. 10px,20px,18px,24px - create 10px margin left, 20px margin top, 18px margin right and 24px margin in bottom.
Ex. 10%,20%,18%,24% - create 10% margin left, 20% margin top, 18% margin right and 24% margin in bottom with respect to the subject size.
crop_margin parameter support max 500px or max 50% of the subject size.
scale
string

This parameter scales the subject in the output image. Can be any range between 10% or 100% depending on the image dimensions. Default position parameter value is `center`, unless any other position parameter value is given.
position
string

This parameter place the subject within the image canvas. Only works when `scale` parameter is given. Default value is `center`. Can be a single value between 0% to 100%(horizontal and vertical) or two values between 0% to 100% separated by comma(eg: 10%,18%) both horizontal and vertical.
preview
boolean

Default value: false. If true it will resize image to 0.25 megapixel. (eg value: 400x600 pixels) 0.20 credit will be charged per preview image. 1 credit will be charged if value set to false
channel
string

This parameter will return the image channel(red, green, blue, alpha) in RGBA or alpha mask format. `rgba` is the default parameter, returns alpha mask when value is set to `alpha`.
roi
string

This parameter when given will let you extract the region of interest of a particular image, only the contents of the selected rectangular will be considered as a foreground and everything else will be considered as background and will be completely removed.
ex. 200px,320px,400px,230px - top-left,bottom-right coordinates.
ex. 10%,15%,25%,30% - top-left,bottom-right with respect to the image size.
car_shadow
boolean

Should an artificial shadow be included in the output (default: true). Please note that currently, the addition of shadows is limited to car photos. For other subjects, shadows will not be applied, even if set to true (though this may change in the future).

Response

Code : 200

Successfully removed image background

Binary image data
Code: 400

Error: Invalid parameters or unable to process input image file (No credit deducted)

Example :

{
"error": "Source image file not found"
}
Code: 401

Error: API-KEY missing or invalid API-KEY (No credit deducted)

Example :

{
"error": "invalid api key"
}
Code: 402

Error: No credits remaining (No credit deducted)

Example :

{
"error": "No credits remaining"
}
Code: 429

Error: Api rate limit crossed (No credit deducted)

Example :

{
"error": "Api rate limit crossed"
}

Credit API Reference

Server URL:https://api.slazzer.com/v2.0

Request Body:multipart/form-data

Method:POST

API:/account

Parameters Request body

api_key
string

Your API key

Response

Code : 200

Successfully fetched credit details

{
    "subscription_plan_credits": XXX,
    "topup_plan_credits": XXX,
    "earn_credits": XXX
    "total_credits": XXX
}

API Rate Limit

You can instantly process upto 500 images per minute via the API, but depending on the input image megapixel resolution.

Input image	Megapixels	Rate Limit ^approx
625 x 400	1 MP	500 images per minute
1200 x 800	1 MP	500 images per minute
1600 x 1200	2 MP	250 images per minute
2500 x 1600	4 MP	125 images per minute
4000 x 2500	10 MP	50 images per minute
6250 x 4000	25 MP	20 images per minute

Background Removal API

Remove image background with just a single API call

Check out our sample code

Remove background from image file

Environment

SLAZZER - SDK

Check out the official android libraryhere

Output Formats

Easily request any one of the 2 formats via our format parameter

API Reference

Authorization

API-KEY

Parameters Request body

source_image_file

source_image_url

source_image_base64

bg_image_file

bg_image_url

bg_image_base64

bg_color_code

format

crop

crop_margin

scale

position

preview

channel

roi

car_shadow

Response

Code : 200

Code: 400

Code: 401

Code: 402

Code: 429

Credit API Reference

Parameters Request body

api_key

Response

Code : 200

API Rate Limit

You can instantly process upto 500 images per minute via the API, but depending on the input image megapixel resolution.

Error code 429 will return if api rate limit exceed & no credit will be charged.

Higher api rate limits are available for enterprise customers. Contact Us