ComfyPilotComfyPilot
文档 / 开发 / 结合 Comfy Router 使用 Image Edit Product Virtual Tryon

结合 Comfy Router 使用 Image Edit Product Virtual Tryon

通过 Comfy Router 调用 bria/image-edit-product-virtual-tryon:端点、请求结构以及 Router 返回的响应。

开发 code 更新于 2026-10-23

查看官方原文

结合 Comfy Router 使用 Image Edit Product Virtual Tryon

通过 Comfy Router 调用 bria/image-edit-product-virtual-tryon:端点、请求结构以及 Router 返回的响应。

bria/image-edit-product-virtual-tryon 的 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-product-virtual-tryon

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

[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-product-virtual-tryon", { "garment_images": ["https://labs-assets.bria.ai/api-examples/virtual-try-on/garment-1.jpg"], "person_image": "https://labs-assets.bria.ai/api-examples/virtual-try-on/person.jpg", }, ) print(result) ` `typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境变量读取 COMFY_API_KEY。 // SDK 会自动创建幂等键,并在自动重试时复用该键。 const { data } = await comfy.models.run("bria/image-edit-product-virtual-tryon", { garment_images: ["https://labs-assets.bria.ai/api-examples/virtual-try-on/garment-1.jpg"], person_image: "https://labs-assets.bria.ai/api-examples/virtual-try-on/person.jpg", }); console.log(data); ` `bash cURL theme={null} curl https://api.comfy.org/v2/models/bria/image-edit-product-virtual-tryon \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"garment_images\": [\"https://labs-assets.bria.ai/api-examples/virtual-try-on/garment-1.jpg\"], \"person_image\": \"https://labs-assets.bria.ai/api-examples/virtual-try-on/person.jpg\"}" ``
[tab] 入队并稍后获取 相同的请求体,发送到 POST https://api.comfy.org/v2/models/bria/image-edit-product-virtual-tryon/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-product-virtual-tryon", { "garment_images": ["https://labs-assets.bria.ai/api-examples/virtual-try-on/garment-1.jpg"], "person_image": "https://labs-assets.bria.ai/api-examples/virtual-try-on/person.jpg", }, ) 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-product-virtual-tryon", { garment_images: ["https://labs-assets.bria.ai/api-examples/virtual-try-on/garment-1.jpg"], person_image: "https://labs-assets.bria.ai/api-examples/virtual-try-on/person.jpg", }); 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-product-virtual-tryon/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"garment_images\": [\"https://labs-assets.bria.ai/api-examples/virtual-try-on/garment-1.jpg\"], \"person_image\": \"https://labs-assets.bria.ai/api-examples/virtual-try-on/person.jpg\"}" # 2. 轮询直到状态为 COMPLETED,每次响应都会给出需要等待的 Retry-After 秒数。 REQUEST_ID="<request_id from the 201 body>" curl -i https://api.comfy.org/v2/models/bria/image-edit-product-virtual-tryon/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" # 3. 取回。返回 200 时携带模型的原生输出,仍在运行时返回 202 和状态响应体。 curl https://api.comfy.org/v2/models/bria/image-edit-product-virtual-tryon/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY" ``

Schema

输入

aspect\_ratio string

输出图像的宽高比,取值为 "1:1"、"2:3"、"3:2"、"3:4"、"4:3"、"4:5"、"5:4"、"9:16" 或 "16:9" 之一。默认为 person\_image 的宽高比。

garment\_images string[] required

一到三张要穿在人物身上的服装或配饰图像。每个条目都是公开可访问的 URL 或 Base64 编码,与 person\_image 相同。

instruction string

针对本次拍摄的可选额外指导,例如“他穿那件藏青色西装外套,搭配他已经穿着的白色 T 恤”。只发送你希望引导的细节,不要发送完整提示词。

output\_type string

输出图像格式,"png" 或 "jpeg"。

person\_image string required

要编辑的人物照片。公开可访问的 URL 或 Base64 编码。接受的格式为 JPEG、JPG、PNG、WEBP。

seed integer

用于确定性生成的种子。如果省略,则使用随机种子。

sync boolean

必须为 false 或省略。Bria 的同步模式(true)会被拒绝,而不会被转发,无论是在 Comfy Router 上,还是在此操作自身的 /proxy/ 路由上都是如此:Comfy Router 会在派发前固定返回模式,并在调用内部轮询结果,而 /proxy/ 路由会返回 request\_id 和 status\_url 以供轮询。

visual\_output\_content\_moderation boolean

如果为 true,则在视觉输出审核失败时返回 422。

根据 Router 在 GET /v2/models/bria/image-edit-product-virtual-tryon/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

提示词的精细化版本;如果 Bria 未对已完成的生成进行精细化,则为 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

示例

输入

{
  "garment_images": [
    "https://labs-assets.bria.ai/api-examples/virtual-try-on/garment-1.jpg"
  ],
  "person_image": "https://labs-assets.bria.ai/api-examples/virtual-try-on/person.jpg"
}

输出

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