Inpaint

POST

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

Edit

Intelligently modify images by filling in or replacing specified areas with new content based
on the content of a "mask" image.

The "mask" is provided in one of two ways:

Explicitly passing in a separate image via the mask parameter

Derived from the alpha channel of the image parameter.

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

prompt

Optionally, the body of the request may also include:

mask

negative_prompt

seed

output_format

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

Output

The resolution of the generated image will be 4 megapixels.

Credits

Flat rate of 3 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 you wish to inpaint.

Supported Formats:

jpeg

png

webp

Validation Rules:

Every side must be at least 64 pixels

Total pixel count must be between 4,096 and 9,437,184 pixels

Example:

./some/image.png

prompt

string

required

What you wish to see in the output image. A strong, descriptive prompt that clearly defines
elements, colors, and subjects will lead to better results.

To control the weight of a given word use the format (word:weight),
where word is the word you'd like to control the weight of and weight
is a value between 0 and 1. For example: The sky was a crisp (blue:0.3) and (green:0.8)
would convey a sky that was blue and green, but more green than blue.

>= 1 characters<= 10000 characters

negative_prompt

string

optional

A blurb of text describing what you do not wish to see in the output image.
This is an advanced feature.

<= 10000 characters

mask

file

optional

Controls the strength of the inpainting process on a per-pixel basis, either via a
second image (passed into this parameter) or via the alpha channel of the image parameter.

Passing in a Mask

The image passed to this parameter should be a black and white image that represents,
at any pixel, the strength of inpainting based on how dark or light the given pixel is.
Completely black pixels represent no inpainting strength while completely white pixels
represent maximum strength.

In the event the mask is a different size than the image parameter, it will be automatically resized.

Alpha Channel Support

If you don't provide an explicit mask, one will be derived from the alpha channel of the image parameter.
Transparent pixels will be inpainted while opaque pixels will be preserved.

In the event an image with an alpha channel is provided along with a mask, the mask will take precedence.

Example:

./some/image.png

grow_mask

number

optional

Grows the edges of the mask outward in all directions by the specified number of pixels. The expanded area around the mask will be blurred, which can help smooth the transition between inpainted content and the original image.

Try this parameter if you notice seams or rough edges around the inpainted content.

Note: Excessive growth may obscure fine details in the mask and/or merge nearby masked regions.

>= 0<= 100

Default:

Example:

seed

number

optional

A specific value that is used to guide the 'randomness' of the generation. (Omit this parameter or pass 0 to use a random seed.)

>= 0<= 4294967294

Default:

output_format

enum<string>

optional

Dictates the content-type of the generated image.

Allowed values:

jpegpngwebp

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/inpaint' \
--header 'authorization;' \
--header 'accept;' \
--header 'stability-client-id;' \
--header 'stability-client-user-id;' \
--header 'stability-client-version;' \
--form 'image=@"./some/image.png"' \
--form 'prompt=""' \
--form 'negative_prompt=""' \
--form 'mask=@"./some/image.png"' \
--form 'grow_mask="5"' \
--form 'seed=""' \
--form 'output_format="png"'

Responses

🟢200Inpainting was successful.

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.

🟠422Your request was well-formed, but rejected. See the `errors` field for details.

🟠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:47

Erase

Outpaint

Inpaint

Try it out#

How to use#

Output#

Credits#

Request

Request samples

Responses

Try it out

How to use

Output

Credits