Remove Background

POST

https://api.ezlinkai.com/v2beta/stable-image/edit/remove-background

Edit

The Remove Background service accurately segments the foreground from an image and implements
and removes the background.

Try it out

Grab your API key and head over to

How to use

Please invoke this endpoint with a POST request.

The headers of the request must include an API key in the authorization field. The body of the request must be
multipart/form-data, and the accept header should be set to one of the following:

image/* to receive the image in the format specified by the output_format parameter.

application/json to receive the image encoded as base64 in a JSON response.

The body of the request must include:

image

Optionally, the body of the request may also include:

output_format

Note: for more details about these parameters please see the request schema below.

Credits

Flat rate of 2 credits per successful generation. You will not be charged for failed generations.

Request

Header Params

authorization

string

required

Your Stability API key, used to authenticate your requests. Although you may have multiple keys in your account, you should use the same key for all requests to this API.

>= 1 characters

content-type

string

required

The content type of the request body. Do not manually specify this header; your HTTP client library will automatically include the appropriate boundary parameter.

>= 1 characters

Example:

multipart/form-data

enum<string>

required

Specify image/* to get the image bytes directly. Otherwise specify application/json to receive the image as base64 encoded JSON.

Allowed values:

image/*application/json

Default:

image/*

stability-client-id

string

optional

The name of your application, used to help us communicate app-specific debugging or moderation issues to you.

<= 256 characters

Example:

my-awesome-app

stability-client-user-id

string

optional

A unique identifier for your end user. Used to help us communicate user-specific debugging or moderation issues to you. Feel free to obfuscate this value to protect user privacy.

<= 256 characters

Example:

DiscordUser#9999

stability-client-version

string

optional

The version of your application, used to help us communicate version-specific debugging or moderation issues to you.

<= 256 characters

Example:

1.2.1

Body Params multipart/form-data

image

file

required

The image whose background you wish to remove.

Supported Formats:

jpeg

png

webp

Validation Rules:

Every side must be at least 64 pixels

Total pixel count must be between 4,096 and 4,194,304 pixels

Example:

./some/image.png

output_format

enum<string>

optional

Dictates the content-type of the generated image.

Allowed values:

pngwebp

Default:

png

Example:

png

Request samples

Python

JavaScript

Shell

Java

Swift

PHP

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.ezlinkai.com/v2beta/stable-image/edit/remove-background' \
--header 'authorization;' \
--header 'accept;' \
--header 'stability-client-id;' \
--header 'stability-client-user-id;' \
--header 'stability-client-version;' \
--form 'image=@"./some/image.png"' \
--form 'output_format="png"'

Responses

🟢200Background successfully removed.

application/json

Body

object {0}

Example

{}

🟠400Invalid parameter(s), see the `errors` field for details.

🟠403Your request was flagged by our content moderation system.

🟠413Your request was larger than 10MiB.

🟠429You have made more than 150 requests in 10 seconds.

🔴500An internal error occurred. If the problem persists [contact support](https://stabilityplatform.freshdesk.com/support/tickets/new).

Modified at 2024-08-18 02:36:59

Search and Replace

Stable Image Ultra

Remove Background

Try it out#

How to use#

Credits#

Request

Request samples

Responses

Try it out

How to use

Credits