结合 Comfy Router 使用 Image Edit Erase By Text

通过 Comfy Router 调用 bria/image-edit-erase-by-text：端点、请求结构以及 Router 返回的响应。

bria/image-edit-erase-by-text 的 API 参考，由 Comfy Router 从 Bria 提供。

​

快速开始

在你的 Comfy 工作区中创建密钥，并将其导出为 COMFY_API_KEY。Python、TypeScript 和 Swift 代码片段使用 Comfy SDK（pip install comfy-sdk、npm install @comfyorg/sdk，以及 ComfySwiftSDK Swift 包）；cURL 代码片段则是通过原始 HTTP 发起的相同调用。

模型 ID： bria/image-edit-erase-by-text

端点： POST https://api.comfy.org/v2/models/bria/image-edit-erase-by-text

等待结果

Python

from comfy_sdk import Comfy

# 从环境变量中读取 COMFY_API_KEY。
# SDK 会自动创建幂等键，并在自动重试时复用它。
with Comfy() as client:
    result = client.models.run(
        "bria/image-edit-erase-by-text",
        {
            "image": "https://img.freepik.com/free-psd/close-up-delicious-apple_23-2151868338.jpg",
            "object_name": "the pie",
        },
    )

print(result)

稍后排队并收集

同一个请求体，发送到 POST https://api.comfy.org/v2/models/bria/image-edit-erase-by-text/requests。只要运行被接纳，Router 就会返回 201 和 request_id，结果准备就绪后再从本进程或另一个进程收集。队列投递 介绍了状态、取消与收集的完整流程。

Python

from comfy_sdk import Comfy

# 从环境变量中读取 COMFY_API_KEY。
# 每次 submit() 调用都会生成自己的 Idempotency-Key，并在自动重试时复用它。
with Comfy() as client:
    handle = client.models.submit(
        "bria/image-edit-erase-by-text",
        {
            "image": "https://img.freepik.com/free-psd/close-up-delicious-apple_23-2151868338.jpg",
            "object_name": "the pie",
        },
    )
    print("request_id:", handle.request_id)  # 配合模型 ID，就是另一个进程所需的全部信息

    # 轮询直到请求完成，按服务器指定的 Retry-After 等待。
    for update in handle.iter_events():
        print(update.status, update.queue_position)

    # 提供商自己的载荷，与 models.run() 返回的值相同。
    # 失败或已取消的请求会在此抛出带类型的 Router 错误。
    result = handle.get()

print(result)

​

Schema

​

输入

image · string · 必填

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

object_name · string · 必填

要移除的对象的文本描述（例如 “the lamp”）。

该内容由 Router 在 GET /v2/models/bria/image-edit-erase-by-text/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

原始提示词。

result.refined_prompt · string

提示词的优化版本；若为 Bria 未做优化的 COMPLETED 生成，则为 null。之所以可为 null，是因为该键是存在的并携带 null，而不是被省略；在 bria/image-edit-gen-fill 上实测观察到。

result.seed · integer

用于生成的种子。

result.structured_prompt · string

详细的 JSON 结构化提示词。

result.video_url · string

已生成视频的 URL。

status · string

请求的当前状态。

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

​

示例

​

输入

{
  "image": "https://img.freepik.com/free-psd/close-up-delicious-apple_23-2151868338.jpg",
  "object_name": "the pie"
}

​

输出

{
  "request_id": "0b3f9d7e-2c41-4a8b-9f10-6d5c8e2a4b71",
  "result": {
    "image_url": "https://example.invalid/bria/image-edit-erase-by-text/generated.png",
    "seed": 42
  },
  "status": "COMPLETED"
}

​

发布前须知

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

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

上文任何字段描述中提到的尺寸限制，都是提供商对该字段自身的限定，引自提供商的规范。Router 会对整个请求体另行设置上限，base64 编码的媒体内容也计入其中：参见请求体大小。

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

请求头

身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。

使用 Router API

模型发现、验证错误、重试与计费。

限制

Router 目前不支持的功能，以及替代方案。