Inpaint
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
maskparameter - Derived from the alpha channel of the
imageparameter.
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 theoutput_formatparameter.application/jsonto receive the image encoded as base64 in a JSON response.
The body of the request must include:
imageprompt
Optionally, the body of the request may also include:
masknegative_promptseedoutput_formatstyle_preset
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 5 credits per successful generation. You will not be charged for failed generations.
Authorizations
Use your Stability API key to authentication requests to this App.
Headers
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.
1The content type of the request body. Do not manually specify this header; your HTTP client library will automatically include the appropriate boundary parameter.
1"multipart/form-data"
Specify image/* to receive the bytes of the image directly. Otherwise specify application/json to receive the image as base64 encoded JSON.
image/*, application/json The name of your application, used to help us communicate app-specific debugging or moderation issues to you.
256"my-awesome-app"
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"DiscordUser#9999"
The version of your application, used to help us communicate version-specific debugging or moderation issues to you.
256"1.2.1"
Body
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
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 - 10000A blurb of text describing what you do not wish to see in the output image. This is an advanced feature.
10000Controls 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.
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 <= x <= 100A specific value that is used to guide the 'randomness' of the generation. (Omit this parameter or pass 0 to use a random seed.)
0 <= x <= 4294967294Dictates the content-type of the generated image.
jpeg, png, webp Guides the image model towards a particular style.
enhance, anime, photographic, digital-art, comic-book, fantasy-art, line-art, analog-film, neon-punk, isometric, low-poly, origami, modeling-compound, cinematic, 3d-model, pixel-art, tile-texture Response
Inpainting was successful.
The bytes of the generated image.
The finish-reason and seed will be present as headers.