stable-image/inpaint

Inpaint an existing image, with or without a mask, using our latest-and-greatest inpainting model.

Search-and-Replace Mode

This mode is ideal for individuals of all levels of skill in design. It can be used for straightforward
adjustments to images. The service will automatically mask the most appropriate object based on the contents
of the search_prompt, and replace it with a generated result based on the prompt.

How to use: set the mode parameter to search and provide a short description of what to
search-and-replace in the search_prompt parameter.

Mask Mode

This mode allows for precise control of generative fill tasks on an image, down to the level of
individual pixels. Design professionals can provide a mask for the section of the image to be replaced,
and use standard image prompting to describe the full image as it should appear after the editing.
The resulting image will incorporate all of the elements described in the prompt.

How to use: set the mode parameter to mask and either pass in an image with an alpha channel
or provide an explicit mask image to the mask parameter. If both are present the mask parameter will
take precedence.

Responses

🟢200Inpainting was successful.

application/json

Body

🟠400Something about your request is invalid, see the `errors` field for details.

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

🔴500An internal error occurred. If the problem persists [contact support](https://platform.stability.ai/support).

Search-and-Replace Mode#

Mask Mode#

Request

Responses

Search-and-Replace Mode

Mask Mode