> ## 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 调用 Image Edit Remove Background Guided

> 通过 Comfy Router 调用 bria/image-edit-remove-background-guided：端点、请求结构以及 Router 返回的响应。

`bria/image-edit-remove-background-guided` 的 API 参考，由 Comfy Router 提供，模型来自 Bria。

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

## 快速开始

在[你的 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：** `bria/image-edit-remove-background-guided`

**端点：** `POST https://api.comfy.org/v2/models/bria/image-edit-remove-background-guided`

**等待结果**

```python Python theme={null}
from comfy_sdk import Comfy

# 从环境变量读取 COMFY_API_KEY。
# SDK 会自动创建幂等键，并在自动重试时复用它。
with Comfy() as client:
    result = client.models.run(
        "bria/image-edit-remove-background-guided",
        {
            "image": "https://labs-assets.bria.ai/api-examples/guided-remove-background/yoga_studio_input.jpg",
            "prompt": "the person with the mat and the plant",
        },
    )

print(result)
```

```typescript TypeScript theme={null}
import { comfy } from "@comfyorg/sdk";

// 从环境变量读取 COMFY_API_KEY。
// SDK 会自动创建幂等键，并在自动重试时复用它。
const { data } = await comfy.models.run("bria/image-edit-remove-background-guided", {
  image: "https://labs-assets.bria.ai/api-examples/guided-remove-background/yoga_studio_input.jpg",
  prompt: "the person with the mat and the plant",
});

console.log(data);
```

```bash cURL theme={null}
curl https://api.comfy.org/v2/models/bria/image-edit-remove-background-guided \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d "{\"image\": \"https://labs-assets.bria.ai/api-examples/guided-remove-background/yoga_studio_input.jpg\", \"prompt\": \"the person with the mat and the plant\"}"
```

**排队并稍后收集**

将相同的请求体发送到 `POST https://api.comfy.org/v2/models/bria/image-edit-remove-background-guided/requests`。运行一经接纳，Router 就会返回 `201` 和一个 `request_id`；结果就绪后，可从当前进程或另一个进程收集它。[队列投递](/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(
            "bria/image-edit-remove-background-guided",
            {
                "image": "https://labs-assets.bria.ai/api-examples/guided-remove-background/yoga_studio_input.jpg",
                "prompt": "the person with the mat and the plant",
            },
        )
        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("bria/image-edit-remove-background-guided", {
  image: "https://labs-assets.bria.ai/api-examples/guided-remove-background/yoga_studio_input.jpg",
  prompt: "the person with the mat and the plant",
});
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/bria/image-edit-remove-background-guided/requests \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d "{\"image\": \"https://labs-assets.bria.ai/api-examples/guided-remove-background/yoga_studio_input.jpg\", \"prompt\": \"the person with the mat and the plant\"}"

# 2. 轮询直到 status 为 COMPLETED，每次响应都会指定需要等待的 Retry-After 秒数。
REQUEST_ID="<request_id from the 201 body>"
curl -i https://api.comfy.org/v2/models/bria/image-edit-remove-background-guided/requests/$REQUEST_ID/status \
  -H "X-API-Key: $COMFY_API_KEY"

# 3. 收集。返回 200 和模型的原生输出；如果仍在运行，则返回 202 和状态正文。
curl https://api.comfy.org/v2/models/bria/image-edit-remove-background-guided/requests/$REQUEST_ID \
  -H "X-API-Key: $COMFY_API_KEY"
```

## Schema

### 输入

**image** `string` *required*

要移除背景的图像。支持的输入类型为 Base64 编码字符串，或指向可公开访问的图像文件的 URL。接受的格式：JPEG、JPG、PNG、WEBP。

**preserve\_alpha** `boolean`

控制背景移除后，输入图像中部分透明的区域是否保留在输出中。

**prompt** `string`

可选的自然语言描述，用于改变默认抠图所保留的内容，例如 "the person with the mat and the plant"、"the woman at her desk without the lamp" 或 "only the chair"。prompt 缺失或为空时，返回标准的 Remove Background 抠图结果。

**sync** `boolean`

必须为 false 或省略。Bria 的同步模式（true）会被拒绝而不会转发，在 Comfy Router 上以及在本操作自有的 `/proxy/` 路由上都是如此：Comfy Router 在派发之前就已固定返回模式，并在调用内部轮询结果；而 `/proxy/` 路由会返回 request\_id 和 status\_url 以供轮询。

**visual\_input\_content\_moderation** `boolean`

启用后，对输入的视觉内容应用内容审核。若图像未通过审核，返回 422。

**visual\_output\_content\_moderation** `boolean`

启用后，对结果的视觉内容应用内容审核。若输出未通过审核，返回 422。

本文档由 Router 在 `GET /v2/models/bria/image-edit-remove-background-guided/openapi.json` 提供的 schema 生成，该文档也是它在请求到达提供商之前校验调用时所依据的同一份文档。

### 输出

**error** `object`

错误对象（仅当 status 为 ERROR 时存在）

**error.code** `integer`

错误码。

**error.details** `string`

额外的错误详情。

**error.message** `string`

报错信息。

**request\_id** `string`

该请求的唯一标识符。

**result** `object`

结果对象（仅当 status 为 COMPLETED 时存在）

**result.image\_url** `string`

已生成/编辑后图像的 URL。

**result.prompt** `string`

原始 prompt。

**result.refined\_prompt** `string`

优化后的 prompt 版本；若 Bria 在一次已完成的生成中未做优化，则为 null。之所以可为空，是因为该键是存在的并携带 null，而不是被省略；这一点在 bria/image-edit-gen-fill 上实际观察到。

**result.seed** `integer`

用于生成的种子。

**result.structured\_instruction** `string`

由 `/v2/structured_instruction/generate` 返回的结构化指令，即以字符串形式序列化的 JSON 文档。该操作既不填充 image\_url 也不填充 video\_url。

**result.structured\_prompt** `string`

详细的 JSON 结构化 prompt。

**result.video\_url** `string`

已生成视频的 URL。

**status** `string`

请求的当前状态。

可能的值：`IN_PROGRESS`、`COMPLETED`、`ERROR`、`UNKNOWN`

## 示例

### 输入

```json theme={null}
{
  "image": "https://labs-assets.bria.ai/api-examples/guided-remove-background/yoga_studio_input.jpg",
  "prompt": "the person with the mat and the plant"
}
```

### 输出

```json theme={null}
{
  "request_id": "0b3f9d7e-2c41-4a8b-9f10-6d5c8e2a4b71",
  "result": {
    "image_url": "https://example.invalid/bria/image-edit-remove-background-guided/generated.png"
  },
  "status": "COMPLETED"
}
```

## 发布前须知

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

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

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

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

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

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


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