Replace Background

Try the API here

Automobile

This POST API is to push batches of images to get processed by Spyne in which the background of the image will be replaced and in the case of Automobile images, the license plate image can be replaced with an image of your choosing.

Attribute

Description

auth_key

The authentication key of the user
sku_name

sku_name

The name of sku you are processing as a string

category_id

The type of images to be processed, can be one of the following, “Automobile”, “Food”

image_data

a JSON object containing batches of images to process

category

In the case of category_id being “Automobile” this parameter can be “exterior”, “interior” or “misc” as per the kind of image input, misc images will not be processed. In case of the category_id being “Food” this parameter will be “Food”

angle

Not applicable for category_id of "Automobile", for "Food" can be "0", "45" or "90" to process images according to how they were shot, flat on the table, a 45 degree or 3/4th view, or 90 degrees/top down.

background_type

This attribute is deprecated, please pass "legacy"

background

The ID of the new background which would be placed into the image

number_plate_logo

Only for category_id of "Automobile", a URL to a logo you would like to replace the number plate with, set to "1" to remove the number plate and make it white, if not included or given a value of "0" then the license plate not be processed

Sample Request

{
    "auth_key":"<AUTH-KEY>",
    "sku_name":"sku-name",
    "category_id":"Automobile",
    "image_data":[
        {
            "category":"Exterior",
            "image_urls":[
                "<Image-URL-1>",
                "<Image-URL-2>"
        
            ]
        },
        {
            "category":"Interior",
            "image_urls":[  
                "<Image-URL-1>",
                "<Image-URL-2>"
            ]
        }
        
    ],
    "background_type":"legacy",
    "background":"923",
    "number_plate_logo":"<NUMBER-PLATE-LOGO-URL>"
}

Food

This POST API is to push batches of images to get processed by Spyne in which the background of the image will be replaced and in the case of Automobile images, the license plate image can be replaced with an image of your choosing.

Attribute

Description

auth_key

The authentication key of the user

sku_name

The name of sku you are processing as a string

category_id

The type of images to be processed, can be one of the following, “Automobile”, “Food”

image_data

a JSON object containing batches of images to process

category

In the case of category_id being “Automobile” this parameter can be “exterior”, “interior” or “misc” as per the kind of image input, misc images will not be processed. In case of the category_id being “Food” this parameter will be “Food”

angle

Not applicable for category_id of "Automobile", for "Food" can be "0", "45" or "90" to process images according to how they were shot, flat on the table, a 45 degree or 3/4th view, or 90 degrees/top down.

background_type

This attribute is deprecated, please pass "legacy"

background

The ID of the new background which would be placed into the image

number_plate_logo

Only for category_id of "Automobile", a URL to a logo you would like to replace the number plate with, set to "1" to remove the number plate and make it white, if not included or given a value of "0" then the license plate not be processed

Sample Request

{
    "auth_key":"<AUTH-KEY>",
    "sku_name":"sku-name",
    "category_id":"Food",
    "image_data":[
        {
            "category":"Food",
            "angle":"0",
            "image_urls":[
                "<Image-URL-1>",
                "<Image-URL-2>"
        
            ]
        },
        {
            "category":"Food",
            "angle":"45",
            "image_urls":[
                "<Image-URL-1>",
                "<Image-URL-2>"
            ]
        },
        {
            "category":"Food",
            "angle":"90",
            "image_urls":[
                "<Image-URL-1>",
                "<Image-URL-2>"
            ]
        }
    ],
    "background_type":"legacy",
    "background":"923"
    }

What’s Next

Try out the API directly!

Did this page help you?