bria/image-edit-replace-background 的 API 参考,由 Comfy Router 从 Bria 提供。
快速开始
在你的 Comfy 工作区中创建一个密钥,并将其导出为COMFY_API_KEY。Python、TypeScript 和 Swift 代码片段使用 Comfy SDK(pip install comfy-sdk、npm install @comfyorg/sdk,以及 ComfySwiftSDK Swift package);cURL 代码片段则是通过原始 HTTP 发起的同一调用。
模型 ID: bria/image-edit-replace-background
端点: POST https://api.comfy.org/v2/models/bria/image-edit-replace-background
- 等待结果
- 排队并稍后收集
Schema
输入
boolean
当为 true(默认值)时,对参考图像进行额外处理可改善结果。
boolean
当为 true 时,即使输入图像带有透明度通道,也会强制进行背景检测与移除。
string
必填
要编辑的图像。支持的输入类型为 Base64 编码的字符串,或指向可公开访问的图像文件的 URL。可接受的格式为 JPEG、JPG、PNG、WEBP。
string
背景生成模式,可为 “base”、“high_control”(默认值)或 “fast”。仅在提供 prompt 时生效。
string
一段文本提示词,用于指定要从生成的背景中排除的概念、风格或对象。
boolean
当为 true 时,输出保持原始图像尺寸。当为 false(默认值)时,输出会被缩放至 1MP。
string
对新背景的文本描述。请提供 prompt 或 ref_images,不要两者同时提供。提示词中的十六进制颜色代码(例如 “#FF5733”)会生成纯色背景。
boolean
启用后,会对提示词应用内容审核。如果提示词未通过审核,则返回 422。
object
一张参考图像或一组参考图像列表,用于指导背景生成,每项均为 Base64 编码的字符串,或指向可公开访问的图像文件的 URL。请提供 prompt 或 ref_images,不要两者同时提供。
boolean
当为 true(默认值)时,提示词会被自动调整,以获得最佳的生成结果。
integer
用于确定性生成的种子。如果省略,则使用随机种子。
boolean
当为 false(默认值)时,请求以异步方式处理。当为
true 时,API 会保持连接打开,直至完成。在 COMFY
ROUTER 上,第二种模式会被拒绝而不是被转发:Router
会在派发前固定返回模式,并在调用内部轮询结果,
因此
POST /v2/models/bria/{model} 对于该路由携带的
任何非 false 或 null 的 sync 都会返回 422
invalid_input(routerForbiddenBodyFields)。同步调用
仍可通过此操作自身的 /proxy/ 路由使用,本 schema
所描述的也正是该接口。boolean
启用后,会对结果视觉内容应用内容审核。如果输出未通过审核,则返回 422。
GET /v2/models/bria/image-edit-replace-background/openapi.json 提供的 schema 生成,该文档与请求到达提供商之前用于校验调用的文档是同一份。
输出
object
错误对象(仅当 status 为 ERROR 时存在)
integer
错误代码。
string
额外的错误详情。
string
报错信息。
string
请求的唯一标识符。
object
结果对象(仅当 status 为 COMPLETED 时存在)
string
已生成或已编辑图像的 URL。
string
原始提示词。
string
提示词的优化版本;对于 Bria 未进行优化的 COMPLETED 生成,则为 null。之所以可为 null,是因为该键是存在的并携带 null,而不是被省略;在 bria/image-edit-gen-fill 上已实际观察到。
integer
用于生成的种子。
string
详细的 JSON 结构化提示词。
string
已生成视频的 URL。
string
请求的当前状态。可能的值:
IN_PROGRESS、COMPLETED、ERROR、UNKNOWN示例
输入
输出
发布前须知
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 目前不支持的功能,以及替代方案。