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

# 将 Sdxl 1.0 Masking 与 Comfy Router 配合使用

> 通过 Comfy Router 调用 stability/sdxl-1.0-masking：端点、请求形状以及 Router 返回的响应。

`stability/sdxl-1.0-masking` 的 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/sdxl-1.0-masking`

**端点：** `POST https://api.comfy.org/v2/models/stability/sdxl-1.0-masking`

> [tab] 等待结果
>
> ```python Python theme={null}
> from comfy_sdk import Comfy
>
> # 从环境变量读取 COMFY_API_KEY。
> # SDK 会自动创建幂等键，并在自动重试时复用它。
> with Comfy() as client:
>     result = client.models.run(
>         "stability/sdxl-1.0-masking",
>         {
>             "init_image": "https://storage.googleapis.com/example-bucket/source.png",
>             "mask_image": "https://storage.googleapis.com/example-bucket/mask.png",
>             "mask_source": "MASK_IMAGE_WHITE",
>             "seed": 12345,
>             "text_prompts": [
>                 {
>                     "text": "a lighthouse on a cliff at sunset, oil painting",
>                 },
>             ],
>         },
>     )
>
> print(result)
> ```
>
> ```typescript TypeScript theme={null}
> import { comfy } from "@comfyorg/sdk";
>
> // 从环境变量读取 COMFY_API_KEY。
> // SDK 会自动创建幂等键，并在自动重试时复用它。
> const { data } = await comfy.models.run("stability/sdxl-1.0-masking", {
>   init_image: "https://storage.googleapis.com/example-bucket/source.png",
>   mask_image: "https://storage.googleapis.com/example-bucket/mask.png",
>   mask_source: "MASK_IMAGE_WHITE",
>   seed: 12345,
>   text_prompts: [
>     {
>       text: "a lighthouse on a cliff at sunset, oil painting",
>     },
>   ],
> });
>
> console.log(data);
> ```
>
> ```bash cURL theme={null}
> curl https://api.comfy.org/v2/models/stability/sdxl-1.0-masking \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"init_image\": \"https://storage.googleapis.com/example-bucket/source.png\", \"mask_image\": \"https://storage.googleapis.com/example-bucket/mask.png\", \"mask_source\": \"MASK_IMAGE_WHITE\", \"seed\": 12345, \"text_prompts\": [{\"text\":\"a lighthouse on a cliff at sunset, oil painting\"}]}"
> ```

> [tab] 加入队列并稍后收集
>
> 相同的请求体，发送到 `POST https://api.comfy.org/v2/models/stability/sdxl-1.0-masking/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/sdxl-1.0-masking",
>             {
>                 "init_image": "https://storage.googleapis.com/example-bucket/source.png",
>                 "mask_image": "https://storage.googleapis.com/example-bucket/mask.png",
>                 "mask_source": "MASK_IMAGE_WHITE",
>                 "seed": 12345,
>                 "text_prompts": [
>                     {
>                         "text": "a lighthouse on a cliff at sunset, oil painting",
>                     },
>                 ],
>             },
>         )
>         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/sdxl-1.0-masking", {
>   init_image: "https://storage.googleapis.com/example-bucket/source.png",
>   mask_image: "https://storage.googleapis.com/example-bucket/mask.png",
>   mask_source: "MASK_IMAGE_WHITE",
>   seed: 12345,
>   text_prompts: [
>     {
>       text: "a lighthouse on a cliff at sunset, oil painting",
>     },
>   ],
> });
> 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/sdxl-1.0-masking/requests \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"init_image\": \"https://storage.googleapis.com/example-bucket/source.png\", \"mask_image\": \"https://storage.googleapis.com/example-bucket/mask.png\", \"mask_source\": \"MASK_IMAGE_WHITE\", \"seed\": 12345, \"text_prompts\": [{\"text\":\"a lighthouse on a cliff at sunset, oil painting\"}]}"
>
> # 2. 轮询直到状态为 COMPLETED，每次响应中按 Retry-After 指定的秒数等待。
> REQUEST_ID="<request_id from the 201 body>"
> curl -i https://api.comfy.org/v2/models/stability/sdxl-1.0-masking/requests/$REQUEST_ID/status \
>   -H "X-API-Key: $COMFY_API_KEY"
>
> # 3. 收集。200 返回模型的原生输出，仍在运行时 202 返回状态正文。
> curl https://api.comfy.org/v2/models/stability/sdxl-1.0-masking/requests/$REQUEST_ID \
>   -H "X-API-Key: $COMFY_API_KEY"
> ```

## Schema

### 输入

**cfg\_scale** `number`

图像遵循提示词的程度。默认值为 7。

范围：`0` 到 `35`

**clip\_guidance\_preset** `string`

Stability 的 CLIP 引导预设，例如 `NONE`。

**extras** `object`

仅为兼容性而接受，会被忽略。

**init\_image** `string (uri)` *required*

源图像的 Comfy 签名资源网址。

格式：`uri`

**mask\_image** `string (uri)`

遮罩的 Comfy 签名资源网址。与 MASK\_IMAGE\_WHITE 和 MASK\_IMAGE\_BLACK 搭配时必填，与 INIT\_IMAGE\_ALPHA 搭配时会被拒绝。

格式：`uri`

**mask\_source** `string` *required*

遮罩的来源。MASK\_IMAGE\_WHITE 和 MASK\_IMAGE\_BLACK 读取 `mask_image`，重绘其中的白色或黑色像素；INIT\_IMAGE\_ALPHA 读取 `init_image` 的透明度通道。

可选值：`MASK_IMAGE_WHITE`、`MASK_IMAGE_BLACK`、`INIT_IMAGE_ALPHA`

**sampler** `string`

Stability 的采样器名称，例如 `K_DPMPP_2M`。

**samples** `integer`

要生成的图像数量。默认值为 1。每张返回的图像都会计费。

范围：`1` 到 `10`

**seed** `integer`

用于整个批处理的种子。为 0 或省略时会随机选取一个种子。

范围：`0` 到 `…`

**steps** `integer`

扩散步数。默认值为 30。

范围：`10` 到 `30`

**style\_preset** `string`

Stability 风格预设，例如 `photographic`。

**text\_prompts** `object[]` *required*

提示词，每个提示词可带一个可选权重。负权重会使其成为负面提示词。

**text\_prompts\[].text** `string` *required*

**text\_prompts\[].weight** `number`

根据 Router 在 `GET /v2/models/stability/sdxl-1.0-masking/openapi.json` 提供的 schema 生成，该文档与它在请求到达提供商之前用于校验调用的文档相同。

### 输出

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

在 200 响应中始终为 SUCCESS。

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

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

格式：`uri`

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

仅限 SDXL，且返回了多张图像时使用。所有 Comfy 签名图片网址，按输出顺序排列，每个有效期最长为 24 小时。

**seed** `integer` *required*

生成该图像时使用的种子。

## 示例

### 输入

```json theme={null}
{
  "init_image": "https://storage.googleapis.com/example-bucket/source.png",
  "mask_image": "https://storage.googleapis.com/example-bucket/mask.png",
  "mask_source": "MASK_IMAGE_WHITE",
  "seed": 12345,
  "text_prompts": [
    {
      "text": "a lighthouse on a cliff at sunset, oil painting"
    }
  ]
}
```

### 输出

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