ComfyPilotComfyPilot
文档 / 开发 / 将 Image Edit Relight 与 Comfy Router 配合使用

将 Image Edit Relight 与 Comfy Router 配合使用

通过 Comfy Router 调用 bria/image-edit-relight：端点、请求形状以及 Router 返回的响应。

开发 code 更新于 2026-10-31

查看官方原文

将 Image Edit Relight 与 Comfy Router 配合使用

通过 Comfy Router 调用 bria/image-edit-relight：端点、请求形状以及 Router 返回的响应。

bria/image-edit-relight 的 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-relight

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

[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-relight", { "image": "https://img.freepik.com/free-photo/portrait-woman_395237-33.jpg?w=740&q=80", "light_direction": "side", "light_type": "midday", }, ) print(result) ` `typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境变量中读取 COMFY_API_KEY。 // SDK 会自动创建一个幂等键，并在自动重试时复用它。 const { data } = await comfy.models.run("bria/image-edit-relight", { image: "https://img.freepik.com/free-photo/portrait-woman_395237-33.jpg?w=740&q=80", light_direction: "side", light_type: "midday", }); console.log(data); ` `bash cURL theme={null} curl https://api.comfy.org/v2/models/bria/image-edit-relight \ -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\", \"light_direction\": \"side\", \"light_type\": \"midday\"}" ``
[tab] 排队并稍后收集 相同的请求体，发送到 POST https://api.comfy.org/v2/models/bria/image-edit-relight/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-relight", { "image": "https://img.freepik.com/free-photo/portrait-woman_395237-33.jpg?w=740&q=80", "light_direction": "side", "light_type": "midday", }, ) 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-relight", { image: "https://img.freepik.com/free-photo/portrait-woman_395237-33.jpg?w=740&q=80", light_direction: "side", light_type: "midday", }); console.log("requestId:", handle.requestId); // 连同模型 ID，就是另一个进程所需的全部信息 // 轮询直到请求完成，按服务器指定的 Retry-After 等待。 for await (const update of handle.events()) { console.log(update.status, update.queuePosition); } // 与 models.run() 返回的结果相同。失败或已取消的请求会在此处 reject。 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-relight/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\", \"light_direction\": \"side\", \"light_type\": \"midday\"}" # 2. 轮询直到状态为 COMPLETED，每次响应都会给出需要等待的 Retry-After 秒数。 REQUEST_ID="<request_id from the 201 body>" curl -i https://api.comfy.org/v2/models/bria/image-edit-relight/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" # 3. 收集。返回 200 及模型的原生输出；仍在运行时返回 202 及状态响应体。 curl https://api.comfy.org/v2/models/bria/image-edit-relight/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY" ``

Schema

输入

image string required

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

light\_direction string required

光照方向，取值为 "front"、"side"、"bottom" 或 "top-down" 之一。

light\_type string required

要应用的光照氛围，取值为 "midday"、"blue hour light"、"low-angle sunlight"、"sunrise light"、"spotlight on subject, keep background settings"、"overcast light"、"soft overcast daylight lighting"、"cloud-filtered lighting"、"fog-diffused lighting"、"moonlight lighting"、"starlight lighting nighttime"、"soft bokeh lighting" 或 "harsh studio lighting keep background setting" 之一。

由 Router 在 GET /v2/models/bria/image-edit-relight/openapi.json 提供的 schema 生成，该文档也是请求到达提供商之前 Router 用于校验调用的同一份文档。

输出

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。可为 null 是因为该键是存在的并携带 null，而不是被省略；在 bria/image-edit-gen-fill 上实际观察到过。

result.seed integer

用于生成的种子。

result.structured\_instruction string

结构化指令，即以字符串形式序列化的 JSON 文档，由 /v2/structured_instruction/generate 返回。该操作不会填充任何一个 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",
  "light_direction": "side",
  "light_type": "midday"
}

输出

{
  "request_id": "0b3f9d7e-2c41-4a8b-9f10-6d5c8e2a4b71",
  "result": {
    "image_url": "https://example.invalid/bria/image-edit-relight/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 目前不支持的功能，以及替代方案。