> ## Documentation Index
> Fetch the complete documentation index at: https://docs.comfy.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Use Edit Inpaint with Comfy Router

> Call stability/edit-inpaint through Comfy Router: endpoint, request shape and the response Router returns.

API Reference for `stability/edit-inpaint`, served by Comfy Router from Stability.

**Input:** Text, Image · **Output:** Image

## Quick start

Create a key in [your Comfy workspace](https://platform.comfy.org/profile/api-keys?onboarding=router) and export it as `COMFY_API_KEY`. The Python and TypeScript snippets use the Comfy SDKs (`pip install comfy-sdk` and `npm install @comfyorg/sdk`); the cURL snippet is the same call over raw HTTP.

**Model ID:** `stability/edit-inpaint`

**Endpoint:** `POST https://api.comfy.org/v2/models/stability/edit-inpaint`

> [tab] Wait for the result
>
> ```python Python theme={null}
> from comfy_sdk import Comfy
>
> # Reads COMFY_API_KEY from the environment.
> # The SDK automatically creates an idempotency key and reuses it for automatic retries.
> with Comfy() as client:
>     result = client.models.run(
>         "stability/edit-inpaint",
>         {
>             "image": "https://storage.googleapis.com/example-bucket/source.png",
>             "mask": "https://storage.googleapis.com/example-bucket/mask.png",
>             "prompt": "a red door",
>             "seed": 12345,
>         },
>     )
>
> print(result)
> ```
>
> ```typescript TypeScript theme={null}
> import { comfy } from "@comfyorg/sdk";
>
> // Reads COMFY_API_KEY from the environment.
> // The SDK automatically creates an idempotency key and reuses it for automatic retries.
> const { data } = await comfy.models.run("stability/edit-inpaint", {
>   image: "https://storage.googleapis.com/example-bucket/source.png",
>   mask: "https://storage.googleapis.com/example-bucket/mask.png",
>   prompt: "a red door",
>   seed: 12345,
> });
>
> console.log(data);
> ```
>
> ```bash cURL theme={null}
> curl https://api.comfy.org/v2/models/stability/edit-inpaint \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"image\": \"https://storage.googleapis.com/example-bucket/source.png\", \"mask\": \"https://storage.googleapis.com/example-bucket/mask.png\", \"prompt\": \"a red door\", \"seed\": 12345}"
> ```

> [tab] Queue and collect later
>
> The same body, sent to `POST https://api.comfy.org/v2/models/stability/edit-inpaint/requests`. Router answers `201` with a `request_id` as soon as the run is admitted, and the result is collected once it is ready, from this process or another one. [Queued delivery](https://docs.comfy.org/development/comfy-router/queue.md) walks through status, cancellation and collection.
>
> ```python Python theme={null}
> import asyncio
> from comfy_sdk import AsyncComfy
>
> # Reads COMFY_API_KEY from the environment.
> # Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
> async def main():
>     async with AsyncComfy() as client:
>         handle = await client.models.submit(
>             "stability/edit-inpaint",
>             {
>                 "image": "https://storage.googleapis.com/example-bucket/source.png",
>                 "mask": "https://storage.googleapis.com/example-bucket/mask.png",
>                 "prompt": "a red door",
>                 "seed": 12345,
>             },
>         )
>         print("request_id:", handle.request_id)  # with the model ID, all another process needs
>
>         # Poll until the request completes, waiting the Retry-After the server names.
>         async for update in handle.iter_events():
>             print(update.status, update.queue_position)
>
>         # The provider's own payload, the same value models.run() returns.
>         # A request that failed or was cancelled raises the typed Router error here.
>         result = await handle.get()
>
>     print(result)
>
> asyncio.run(main())
> ```
>
> ```typescript TypeScript theme={null}
> import { comfy } from "@comfyorg/sdk";
>
> // Reads COMFY_API_KEY from the environment.
> // Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
> const handle = await comfy.models.submit("stability/edit-inpaint", {
>   image: "https://storage.googleapis.com/example-bucket/source.png",
>   mask: "https://storage.googleapis.com/example-bucket/mask.png",
>   prompt: "a red door",
>   seed: 12345,
> });
> console.log("requestId:", handle.requestId); // with the model ID, all another process needs
>
> // Poll until the request completes, waiting the Retry-After the server names.
> for await (const update of handle.events()) {
>   console.log(update.status, update.queuePosition);
> }
>
> // The same result models.run() returns. A request that failed or was cancelled rejects here.
> const result = await handle.get();
>
> console.log(result.data);
> ```
>
> ```bash cURL theme={null}
> # 1. Submit. Router answers 201 with request_id, status_url, response_url and cancel_url.
> curl https://api.comfy.org/v2/models/stability/edit-inpaint/requests \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"image\": \"https://storage.googleapis.com/example-bucket/source.png\", \"mask\": \"https://storage.googleapis.com/example-bucket/mask.png\", \"prompt\": \"a red door\", \"seed\": 12345}"
>
> # 2. Poll until status is COMPLETED, waiting the Retry-After seconds each response names.
> REQUEST_ID="<request_id from the 201 body>"
> curl -i https://api.comfy.org/v2/models/stability/edit-inpaint/requests/$REQUEST_ID/status \
>   -H "X-API-Key: $COMFY_API_KEY"
>
> # 3. Collect. 200 with the model's native output, 202 with the status body while it is still running.
> curl https://api.comfy.org/v2/models/stability/edit-inpaint/requests/$REQUEST_ID \
>   -H "X-API-Key: $COMFY_API_KEY"
> ```

## Schema

### Input

**grow\_mask** `integer`

How far, in pixels, to grow the mask. Default 5.

Range: `0` to `100`

**image** `string (uri)` *required*

A Comfy-signed asset URL of the source image.

Format: `uri`

**mask** `string (uri)`

A Comfy-signed asset URL of the mask. White marks the area to repaint. Omitted, the image's own alpha is the mask.

Format: `uri`

**negative\_prompt** `string`

What to keep out of the painted area.

**output\_format** `string`

Only `png` is returned.

Possible values: `png`

**prompt** `string` *required*

What to paint into the masked area.

**seed** `integer`

0 or omitted picks a random seed.

Range: `0` to `4294967294`

Generated from the schema Router serves at `GET /v2/models/stability/edit-inpaint/openapi.json`, the same document it validates a call against before the request reaches the provider.

### Output

**finish\_reason** `string` *required*

Always SUCCESS on a 200.

**image** `string (uri)` *required*

Comfy-signed URL of the (first) PNG image, valid for up to 24 hours.

Format: `uri`

**images** `string (uri)[]`

SDXL only, when more than one image was returned. Every Comfy-signed image URL, in output order, each valid for up to 24 hours.

**seed** `integer` *required*

The seed the image was generated with.

## Examples

### Input

```json theme={null}
{
  "image": "https://storage.googleapis.com/example-bucket/source.png",
  "mask": "https://storage.googleapis.com/example-bucket/mask.png",
  "prompt": "a red door",
  "seed": 12345
}
```

### Output

```json theme={null}
{
  "finish_reason": "SUCCESS",
  "image": "https://example.invalid/stability/image.png",
  "seed": 12345
}
```

## Before you ship

The SDKs create an `Idempotency-Key` and reuse it for automatic retries. For manual retries, reuse the original key. Router can hold the connection for up to 10 minutes.

When a request fails, Router sends an `X-Comfy-Error-Type` response header explaining why. A `422` means Router rejected the input before calling the provider, and a `413` means the request body was larger than Router accepts. Download generated assets promptly because [result URLs can expire](https://docs.comfy.org/development/comfy-router/reference.md#result-assets).

Any size limit named in a field description above is the provider's own bound on that field, quoted from the provider's specification. Router applies a separate cap to the whole request body, which base64-encoded media counts against: see [request body size](https://docs.comfy.org/development/comfy-router/limitations.md#request-bodies-are-capped).

This page documents one partner model called through Comfy Router. The same `comfy-sdk` / `@comfyorg/sdk` package also ships a second client, for running a whole ComfyUI workflow graph on Comfy Cloud: `Comfy(api_key=...)` / `new Comfy({ apiKey })`, with `client.workflows`, `client.assets` and `client.jobs`. See [Comfy SDKs](https://docs.comfy.org/development/api-development/sdks.md).

> [card] [Headers](https://docs.comfy.org/development/comfy-router/headers.md)
>
> Authentication, idempotency, request IDs, error buckets, retry pacing, spend limits.

> [card] [Using the Router API](https://docs.comfy.org/development/comfy-router/api.md)
>
> Model discovery, validation errors, retries, and billing.

> [card] [Limitations](https://docs.comfy.org/development/comfy-router/limitations.md)
>
> What Router does not do today, and what to use instead.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.