将 Edit Replace Background And Relight 与 Comfy Router 配合使用

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

stability/edit-replace-background-and-relight 的 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-replace-background-and-relight

端点： POST https://api.comfy.org/v2/models/stability/edit-replace-background-and-relight

[tab] 等待结果 ``python Python theme={null} from comfy_sdk import Comfy # 从环境变量读取 COMFY_API_KEY。 # SDK 会自动创建幂等键，并在自动重试时复用它。 with Comfy() as client: result = client.models.run( "stability/edit-replace-background-and-relight", { "background_prompt": "a sunlit beach at golden hour", "light_source_direction": "above", "light_source_strength": 0.5, "seed": 12345, "subject_image": "https://storage.googleapis.com/example-bucket/subject.png", }, ) print(result) ` `typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境变量读取 COMFY_API_KEY。 // SDK 会自动创建幂等键，并在自动重试时复用它。 const { data } = await comfy.models.run("stability/edit-replace-background-and-relight", { background_prompt: "a sunlit beach at golden hour", light_source_direction: "above", light_source_strength: 0.5, seed: 12345, subject_image: "https://storage.googleapis.com/example-bucket/subject.png", }); console.log(data); ` `bash cURL theme={null} curl https://api.comfy.org/v2/models/stability/edit-replace-background-and-relight \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"background_prompt\": \"a sunlit beach at golden hour\", \"light_source_direction\": \"above\", \"light_source_strength\": 0.5, \"seed\": 12345, \"subject_image\": \"https://storage.googleapis.com/example-bucket/subject.png\"}" ``

[tab] 排队并稍后收集 同一个请求体，发送到 POST https://api.comfy.org/v2/models/stability/edit-replace-background-and-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( "stability/edit-replace-background-and-relight", { "background_prompt": "a sunlit beach at golden hour", "light_source_direction": "above", "light_source_strength": 0.5, "seed": 12345, "subject_image": "https://storage.googleapis.com/example-bucket/subject.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-replace-background-and-relight", { background_prompt: "a sunlit beach at golden hour", light_source_direction: "above", light_source_strength: 0.5, seed: 12345, subject_image: "https://storage.googleapis.com/example-bucket/subject.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-replace-background-and-relight/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"background_prompt\": \"a sunlit beach at golden hour\", \"light_source_direction\": \"above\", \"light_source_strength\": 0.5, \"seed\": 12345, \"subject_image\": \"https://storage.googleapis.com/example-bucket/subject.png\"}" # 2. 轮询直到状态为 COMPLETED，并按照每次响应指定的 Retry-After 秒数等待。 REQUEST_ID="<request_id from the 201 body>" curl -i https://api.comfy.org/v2/models/stability/edit-replace-background-and-relight/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" # 3. 收集。状态码 200 返回模型的原始输出，202 则在请求仍在运行时返回状态响应体。 curl https://api.comfy.org/v2/models/stability/edit-replace-background-and-relight/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY" ``

Schema

输入

background\_prompt string

新的背景。省略 background_reference 时为必填。

background\_reference string (uri)

新背景所遵循的图像的 Comfy 签名资源网址。

格式：uri

foreground\_prompt string

主体是什么。

keep\_original\_background string

true 会保留原始背景的元素。默认 false。字符串类型，与 Stability 表单字段一致。

可能的值：true、false

light\_reference string (uri)

光照所遵循的图像的 Comfy 签名资源网址。

格式：uri

light\_source\_direction string

光线的来源方向。不提供 left。

可能的值：right、below、above

light\_source\_strength number

光线的强度。需要 light_reference 或 light_source_direction。

范围：0 到 1

negative\_prompt string

要从图像中排除的内容。

original\_background\_depth number

新背景与主体景深的匹配程度。默认 0.5。

范围：0 到 1

output\_format string

仅返回 png。

可能的值：png

preserve\_original\_subject number

保留原始主体的精确程度。默认 0.6。

范围：0 到 1

seed integer

0 或省略时会随机选择种子。

范围：0 到 4294967294

subject\_image string (uri) required

保留其主体的图像的 Comfy 签名资源网址。

格式：uri

根据 Router 在 GET /v2/models/stability/edit-replace-background-and-relight/openapi.json 提供的 schema 生成，与它在请求送达提供商之前校验调用所用的文档相同。

输出

finish\_reason string required

在 200 响应中始终为 SUCCESS。

image string (uri) required

（第一张）PNG 图像的 Comfy 签名网址，有效期最长 24 小时。

格式：uri

images string (uri)[]

仅 SDXL，且返回了多张图像时。按输出顺序列出每个 Comfy 签名图片网址，每个有效期最长 24 小时。

seed integer required

生成该图像所用的种子。

示例

输入

{
  "background_prompt": "a sunlit beach at golden hour",
  "light_source_direction": "above",
  "light_source_strength": 0.5,
  "seed": 12345,
  "subject_image": "https://storage.googleapis.com/example-bucket/subject.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 目前不支持的功能，以及替代方案。