ComfyPilotComfyPilot
文档 / 开发 / 在 Comfy Router 中使用 Image Edit Restore

在 Comfy Router 中使用 Image Edit Restore

通过 Comfy Router 调用 bria/image-edit-restore:endpoint、请求形状以及 Router 返回的响应。

开发 code 更新于 2026-10-19

查看官方原文

在 Comfy Router 中使用 Image Edit Restore

通过 Comfy Router 调用 bria/image-edit-restore:endpoint、请求形状以及 Router 返回的响应。

bria/image-edit-restore 的 API 参考,由 Comfy Router 从 Bria 提供。

输入: 图像 · 输出: 图像

快速开始

在你的 Comfy 工作区中创建密钥,并将其导出为 COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK(pip install comfy-sdk 和 npm install @comfyorg/sdk);cURL 代码片段则是通过原始 HTTP 发出的同一调用。

模型 ID: bria/image-edit-restore

端点: POST https://api.comfy.org/v2/models/bria/image-edit-restore

[tab] 等待结果 ``python Python theme={null} from comfy_sdk import Comfy # 从环境变量中读取 COMFY_API_KEY。 # SDK 会自动创建幂等键,并在自动重试时复用该键。 with Comfy() as client: result = client.models.run( "bria/image-edit-restore", { "image": "https://img.freepik.com/free-photo/portrait-woman_395237-33.jpg?w=740&q=80", }, ) print(result) ` `typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境变量中读取 COMFY_API_KEY。 // SDK 会自动创建幂等键,并在自动重试时复用该键。 const { data } = await comfy.models.run("bria/image-edit-restore", { image: "https://img.freepik.com/free-photo/portrait-woman_395237-33.jpg?w=740&q=80", }); console.log(data); ` `bash cURL theme={null} curl https://api.comfy.org/v2/models/bria/image-edit-restore \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"image\": \"https://img.freepik.com/free-photo/portrait-woman_395237-33.jpg?w=740&q=80\"}" ``
[tab] 入队并稍后收集 相同的请求体,发送到 POST https://api.comfy.org/v2/models/bria/image-edit-restore/requests。运行一旦被接受,Router 就会立即返回 201 和 request_id,结果准备就绪后即可收集,无论是从当前进程还是其他进程。队列投递 介绍了状态、取消和收集的完整流程。 ``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-restore", { "image": "https://img.freepik.com/free-photo/portrait-woman_395237-33.jpg?w=740&q=80", }, ) 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-restore", { image: "https://img.freepik.com/free-photo/portrait-woman_395237-33.jpg?w=740&q=80", }); 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-restore/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"image\": \"https://img.freepik.com/free-photo/portrait-woman_395237-33.jpg?w=740&q=80\"}" # 2. 轮询直到状态为 COMPLETED,每次等待响应中指定的 Retry-After 秒数。 REQUEST_ID="<request_id from the 201 body>" curl -i https://api.comfy.org/v2/models/bria/image-edit-restore/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" # 3. 收集。返回 200 并带上模型的原生输出,仍在运行时返回 202 和状态体。 curl https://api.comfy.org/v2/models/bria/image-edit-restore/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY" ``

Schema

输入

image string required

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

由 Router 在 GET /v2/models/bria/image-edit-restore/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

提示词的润色版本;当一次 COMPLETED 的生成中 Bria 未做润色时为 null。之所以可空,是因为该键是 PRESENT 并携带 null,而不是被省略;这一点在 bria/image-edit-gen-fill 上有实际观察记录。

result.seed integer

生成所使用的种子。

result.structured\_instruction string

结构化指令,即由 /v2/structured_instruction/generate 返回的、序列化为字符串的 JSON 文档。该操作不会填充任何一个 URL。

result.structured\_prompt string

详细的 JSON 结构化提示词。

result.video\_url string

已生成视频的 URL。

status string

请求的当前状态。

可能的值:IN_PROGRESS, COMPLETED, ERROR, UNKNOWN

示例

输入

{
  "image": "https://img.freepik.com/free-photo/portrait-woman_395237-33.jpg?w=740&q=80"
}

输出

{
  "request_id": "0b3f9d7e-2c41-4a8b-9f10-6d5c8e2a4b71",
  "result": {
    "image_url": "https://example.invalid/bria/image-edit-restore/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。

[card] 请求头 身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。
[card] 使用 Router API 模型发现、验证错误、重试与计费。
[card] 限制 Router 目前不支持的功能,以及替代方案。