> ## 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.

# 使用 Comfy Router 调用 Edit Search And Replace

> 通过 Comfy Router 调用 stability/edit-search-and-replace：端点、请求形状以及 Router 返回的响应。

`stability/edit-search-and-replace` 的 API 参考，由 Stability 通过 Comfy Router 提供。

**输入：** 文本、图像 · **输出：** 图像

## 快速开始

在[你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys?onboarding=router)中创建一个密钥，并将其导出为 `COMFY_API_KEY`。Python 和 TypeScript 代码片段使用 Comfy SDK（`pip install comfy-sdk` 和 `npm install @comfyorg/sdk`）；cURL 代码片段是通过原始 HTTP 进行的相同调用。

**模型 ID：** `stability/edit-search-and-replace`

**端点：** `POST https://api.comfy.org/v2/models/stability/edit-search-and-replace`

> [tab] 等待结果
>
> ```python Python theme={null}
> from comfy_sdk import Comfy
>
> # 从环境变量中读取 COMFY_API_KEY。
> # SDK 会自动创建幂等键，并在自动重试时复用它。
> with Comfy() as client:
>     result = client.models.run(
>         "stability/edit-search-and-replace",
>         {
>             "image": "https://storage.googleapis.com/example-bucket/source.png",
>             "prompt": "a dog",
>             "search_prompt": "the cat",
>             "seed": 12345,
>         },
>     )
>
> print(result)
> ```
>
> ```typescript TypeScript theme={null}
> import { comfy } from "@comfyorg/sdk";
>
> // 从环境变量中读取 COMFY_API_KEY。
> // SDK 会自动创建幂等键，并在自动重试时复用它。
> const { data } = await comfy.models.run("stability/edit-search-and-replace", {
>   image: "https://storage.googleapis.com/example-bucket/source.png",
>   prompt: "a dog",
>   search_prompt: "the cat",
>   seed: 12345,
> });
>
> console.log(data);
> ```
>
> ```bash cURL theme={null}
> curl https://api.comfy.org/v2/models/stability/edit-search-and-replace \
>   -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\", \"prompt\": \"a dog\", \"search_prompt\": \"the cat\", \"seed\": 12345}"
> ```

> [tab] 排队并稍后收集
>
> 同一个请求体，发送到 `POST https://api.comfy.org/v2/models/stability/edit-search-and-replace/requests`。运行一旦被接纳，Router 就会返回 `201` 和一个 `request_id`，结果就绪后，可从当前进程或另一个进程收集。[队列投递](https://docs.comfy.org/zh/development/comfy-router/queue.md) 将介绍状态、取消和收集的完整流程。
>
> ```python Python theme={null}
> import asyncio
> from comfy_sdk import AsyncComfy
>
> # 从环境变量中读取 COMFY_API_KEY。
> # 每次 submit() 调用都会生成自己的 Idempotency-Key，并在自动重试时复用它。
> async def main():
>     async with AsyncComfy() as client:
>         handle = await client.models.submit(
>             "stability/edit-search-and-replace",
>             {
>                 "image": "https://storage.googleapis.com/example-bucket/source.png",
>                 "prompt": "a dog",
>                 "search_prompt": "the cat",
>                 "seed": 12345,
>             },
>         )
>         print("request_id:", handle.request_id)  # 配合模型 ID，另一个进程只需这些
>
>         # 轮询直到请求完成，并等待服务器指定的 Retry-After 时间。
>         async for update in handle.iter_events():
>             print(update.status, update.queue_position)
>
>         # 提供商自己的负载，与 models.run() 返回的值相同。
>         # 失败或已取消的请求会在这里抛出类型化的 Router 错误。
>         result = await handle.get()
>
>     print(result)
>
> asyncio.run(main())
> ```
>
> ```typescript TypeScript theme={null}
> import { comfy } from "@comfyorg/sdk";
>
> // 从环境变量中读取 COMFY_API_KEY。
> // 每次 submit() 调用都会生成自己的 Idempotency-Key，并在自动重试时复用它。
> const handle = await comfy.models.submit("stability/edit-search-and-replace", {
>   image: "https://storage.googleapis.com/example-bucket/source.png",
>   prompt: "a dog",
>   search_prompt: "the cat",
>   seed: 12345,
> });
> console.log("requestId:", handle.requestId); // 配合模型 ID，另一个进程只需这些
>
> // 轮询直到请求完成，并等待服务器指定的 Retry-After 时间。
> for await (const update of handle.events()) {
>   console.log(update.status, update.queuePosition);
> }
>
> // 与 models.run() 返回的结果相同。失败或已取消的请求会在这里被拒绝。
> const result = await handle.get();
>
> console.log(result.data);
> ```
>
> ```bash cURL theme={null}
> # 1. 提交。Router 会返回 201，并附带 request_id、status_url、response_url 和 cancel_url。
> curl https://api.comfy.org/v2/models/stability/edit-search-and-replace/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\", \"prompt\": \"a dog\", \"search_prompt\": \"the cat\", \"seed\": 12345}"
>
> # 2. 轮询直到状态为 COMPLETED，每次等待响应中指定的 Retry-After 秒数。
> REQUEST_ID="<request_id from the 201 body>"
> curl -i https://api.comfy.org/v2/models/stability/edit-search-and-replace/requests/$REQUEST_ID/status \
>   -H "X-API-Key: $COMFY_API_KEY"
>
> # 3. 收集。返回 200 时包含模型的原始输出，仍在运行时返回 202 和状态正文。
> curl https://api.comfy.org/v2/models/stability/edit-search-and-replace/requests/$REQUEST_ID \
>   -H "X-API-Key: $COMFY_API_KEY"
> ```

## Schema

### 输入

**grow\_mask** `integer`

以像素为单位，将找到的区域向外扩展多少。默认值为 3。

范围：`0` 到 `20`

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

来源图像的由 Comfy 签名的资源 URL。

格式：`uri`

**negative\_prompt** `string`

替换时要排除的内容。

**output\_format** `string`

仅返回 `png`。

可能的值：`png`

**prompt** `string` *required*

用什么来替换找到的对象。

**search\_prompt** `string` *required*

要在图像中搜索什么。

**seed** `integer`

`0` 或省略时会随机选择种子。

范围：`0` 到 `4294967294`

根据 Router 在 `GET /v2/models/stability/edit-search-and-replace/openapi.json` 提供的 Schema 生成，该文档也是请求到达提供商之前用于验证调用的同一份文档。

### 输出

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

返回 200 时始终为 SUCCESS。

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

（第一张）PNG 图像的由 Comfy 签名的 URL，有效期最长 24 小时。

格式：`uri`

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

仅限 SDXL，当返回多张图像时使用。按输出顺序列出每个由 Comfy 签名的图像 URL，每个 URL 有效期最长 24 小时。

**seed** `integer` *required*

生成图像时使用的种子。

## 示例

### 输入

```json theme={null}
{
  "image": "https://storage.googleapis.com/example-bucket/source.png",
  "prompt": "a dog",
  "search_prompt": "the cat",
  "seed": 12345
}
```

### 输出

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

## 发布前须知

SDK 会生成 `Idempotency-Key` 并在自动重试中复用它。手动重试时，请复用原始 key。Router 最长可保持连接 10 分钟。

请求失败时，Router 会发送 `X-Comfy-Error-Type` 响应头说明原因。`422` 表示 Router 在调用提供商之前就拒绝了输入，`413` 表示请求体超出了 Router 可接受的大小。已生成的资源请及时下载，因为[结果 URL 会过期](https://docs.comfy.org/zh/development/comfy-router/reference.md#结果资产)。

上文任何字段描述中提到的尺寸限制，都是提供商对该字段自身的限定，引自提供商的规范。Router 会对整个请求体另行设置上限，base64 编码的媒体内容也计入其中：参见[请求体大小](https://docs.comfy.org/zh/development/comfy-router/limitations.md)。

本页记录的是通过 Comfy Router 调用的某一个合作伙伴模型。同一个 `comfy-sdk` / `@comfyorg/sdk` 包还提供第二个客户端，用于在 Comfy Cloud 上运行完整的 ComfyUI 工作流图：`Comfy(api_key=...)` / `new Comfy({ apiKey })`，并带有 `client.workflows`、`client.assets` 和 `client.jobs`。请参阅 [Comfy SDKs](https://docs.comfy.org/zh/development/api-development/sdks.md)。

> [card] [请求头](https://docs.comfy.org/zh/development/comfy-router/headers.md)
>
> 身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。

> [card] [使用 Router API](https://docs.comfy.org/zh/development/comfy-router/api.md)
>
> 模型发现、验证错误、重试与计费。

> [card] [限制](https://docs.comfy.org/zh/development/comfy-router/limitations.md)
>
> Router 目前不支持的功能，以及替代方案。


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