import requests

response = requests.post(
    f"https://api.stability.ai/v2beta/stable-image/edit/remove-background",
    headers={
        "authorization": f"Bearer sk-MYAPIKEY",
        "accept": "image/*"
    },
    files={
        "image": open("./husky-in-a-field.png", "rb")
    },
    data={
        "output_format": "webp"
    },
)

if response.status_code == 200:
    with open("./husky.webp", 'wb') as file:
        file.write(response.content)
else:
    raise Exception(str(response.json()))

"The bytes of the generated png"

{
  "id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
  "name": "bad_request",
  "errors": [
    "some-field: is required"
  ]
}

{
  "id": "ed14db44362126aab3cbd25cca51ffe3",
  "name": "content_moderation",
  "errors": [
    "Your request was flagged by our content moderation system, as a result your request was denied and you were not charged."
  ]
}

{
  "id": "4212a4b66fbe1cedca4bf2133d35dca5",
  "name": "payload_too_large",
  "errors": [
    "body: payloads cannot be larger than 10MiB in size"
  ]
}

{
  "id": "rate_limit_exceeded",
  "name": "rate_limit_exceeded",
  "errors": [
    "You have exceeded the rate limit of 150 requests within a 10 second period, and have been timed out for 60 seconds."
  ]
}

{
  "id": "2a1b2d4eafe2bc6ab4cd4d5c6133f513",
  "name": "internal_error",
  "errors": [
    "An unexpected server error has occurred, please try again later."
  ]
}

Edit

Remove Background

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 5 credits per successful generation. You will not be charged for failed generations.

POST

v2beta

stable-image

edit

remove-background

import requests

response = requests.post(
    f"https://api.stability.ai/v2beta/stable-image/edit/remove-background",
    headers={
        "authorization": f"Bearer sk-MYAPIKEY",
        "accept": "image/*"
    },
    files={
        "image": open("./husky-in-a-field.png", "rb")
    },
    data={
        "output_format": "webp"
    },
)

if response.status_code == 200:
    with open("./husky.webp", 'wb') as file:
        file.write(response.content)
else:
    raise Exception(str(response.json()))

"The bytes of the generated png"

{
  "id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
  "name": "bad_request",
  "errors": [
    "some-field: is required"
  ]
}

{
  "id": "ed14db44362126aab3cbd25cca51ffe3",
  "name": "content_moderation",
  "errors": [
    "Your request was flagged by our content moderation system, as a result your request was denied and you were not charged."
  ]
}

{
  "id": "4212a4b66fbe1cedca4bf2133d35dca5",
  "name": "payload_too_large",
  "errors": [
    "body: payloads cannot be larger than 10MiB in size"
  ]
}

{
  "id": "rate_limit_exceeded",
  "name": "rate_limit_exceeded",
  "errors": [
    "You have exceeded the rate limit of 150 requests within a 10 second period, and have been timed out for 60 seconds."
  ]
}

{
  "id": "2a1b2d4eafe2bc6ab4cd4d5c6133f513",
  "name": "internal_error",
  "errors": [
    "An unexpected server error has occurred, please try again later."
  ]
}

Authorizations

authorization

string

header

required

Use your Stability API key to authentication requests to this App.

Headers

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.

Minimum string length: 1

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.

Minimum string length: 1

Example:

"multipart/form-data"

enum<string>

default:image/*

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

Available options:

image/*,

application/json

stability-client-id

string

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

Maximum string length: 256

Example:

"my-awesome-app"

stability-client-user-id

string

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.

Maximum string length: 256

Example:

"DiscordUser#9999"

stability-client-version

string

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

Maximum string length: 256

Example:

"1.2.1"

Body

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

output_format

enum<string>

default:png

Dictates the content-type of the generated image.

Available options:

png,

webp

Response

Background successfully removed.

The bytes of the generated image.

The finish-reason and seed will be present as headers.