使用 Comfy Router 调用 Edit Remove Background
通过 Comfy Router 调用 stability/edit-remove-background:端点、请求结构与 Router 返回的响应。
使用 Comfy Router 调用 Edit Remove Background
通过 Comfy Router 调用 stability/edit-remove-background:端点、请求结构与 Router 返回的响应。
stability/edit-remove-background 的 API 参考,由 Comfy Router 从 Stability 提供。
输入: 图像 · 输出: 图像
快速开始
在你的 Comfy 工作区中创建一个密钥,并将其导出为 COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK(pip install comfy-sdk 和 npm install @comfyorg/sdk);cURL 代码片段则是通过原始 HTTP 发起的同一调用。
模型 ID: stability/edit-remove-background
端点: POST https://api.comfy.org/v2/models/stability/edit-remove-background
[tab] 等待结果 ``python Python theme={null} from comfy_sdk import Comfy # 从环境变量中读取 COMFY_API_KEY。 # SDK 会自动创建幂等键,并在自动重试时复用它。 with Comfy() as client: result = client.models.run( "stability/edit-remove-background", { "image": "https://storage.googleapis.com/example-bucket/source.png", }, ) print(result)``typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境变量中读取 COMFY_API_KEY。 // SDK 会自动创建幂等键,并在自动重试时复用它。 const { data } = await comfy.models.run("stability/edit-remove-background", { image: "https://storage.googleapis.com/example-bucket/source.png", }); console.log(data);``bash cURL theme={null} curl https://api.comfy.org/v2/models/stability/edit-remove-background \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"image\": \"https://storage.googleapis.com/example-bucket/source.png\"}"``
[tab] 排队并稍后收集 相同的请求体,发送到POST https://api.comfy.org/v2/models/stability/edit-remove-background/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( "stability/edit-remove-background", { "image": "https://storage.googleapis.com/example-bucket/source.png", }, ) 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("stability/edit-remove-background", { image: "https://storage.googleapis.com/example-bucket/source.png", }); 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/stability/edit-remove-background/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"image\": \"https://storage.googleapis.com/example-bucket/source.png\"}" # 2. 轮询直到状态为 COMPLETED,每次响应都会指明需要等待的 Retry-After 秒数。 REQUEST_ID="<request_id from the 201 body>" curl -i https://api.comfy.org/v2/models/stability/edit-remove-background/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" # 3. 收集。返回 200 时给出模型的原生输出,仍在运行时返回 202 和状态响应体。 curl https://api.comfy.org/v2/models/stability/edit-remove-background/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY"``
Schema
输入
image string (uri) required
来源图像的 Comfy 签名资产网址。
格式:uri
output\_format string
仅返回 png。
可选值:png
本文档根据 Router 在 GET /v2/models/stability/edit-remove-background/openapi.json 提供的 schema 生成,Router 在请求到达提供商之前正是依据同一份文档校验调用。
输出
finish\_reason string required
在 200 响应中始终为 SUCCESS。
image string (uri) required
第一张(或唯一一张)PNG 图像的 Comfy 签名网址,有效期最长 24 小时。
格式:uri
images string (uri)[]
仅 SDXL,当返回多张图像时出现。按输出顺序列出每一个 Comfy 签名图片网址,每个网址的有效期最长 24 小时。
seed integer required
生成该图像时使用的种子。
示例
输入
{
"image": "https://storage.googleapis.com/example-bucket/source.png"
}
输出
{
"finish_reason": "SUCCESS",
"image": "https://example.invalid/stability/image.png",
"seed": 12345
}
发布前须知
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 目前不支持的功能,以及替代方案。