v6

latestOpenAPI 3.0.3raw.githubusercontent.com2025-03-0663270.5 KB
Version1.Image

Image-to-image with a mask

Selectively modify portions of an image using a mask. The mask must be the same shape and size as the init image. This endpoint also supports image parameters with alpha channels. See below for more details.

NOTE: Only Version 1 engines will work with this endpoint.

post/v1/generation/{engine_id}/image-to-image/masking

Path parameters

engine_idstring required

Headers

Organizationstring

Allows for requests to be scoped to an organization other than the user's default. If not provided, the user's default organization will be used.

Stability-Client-IDstring

Used to identify the source of requests, such as the client application or sub-organization. Optional, but recommended for organizational clarity.

Stability-Client-Versionstring

Used to identify the version of the application or service making the requests. Optional, but recommended for organizational clarity.

Response

Generation successful.

Example response

{
  "artifacts": [
    {
      "finishReason": "CONTENT_FILTERED",
      "seed": 1229191277
    }
  ]
}