ComfyPilotComfyPilot
文档 / 开发 / 通过 Comfy Router 使用 Gen 4 Image

通过 Comfy Router 使用 Gen 4 Image

通过 Comfy Router 调用 runway/gen4_image：端点、请求结构以及 Router 返回的响应。

开发 code 更新于 2026-11-03

查看官方原文

通过 Comfy Router 使用 Gen 4 Image

通过 Comfy Router 调用 runway/gen4_image：端点、请求结构以及 Router 返回的响应。

runway/gen4_image 的 API 参考，由 Comfy Router 从 Runway 提供。

输入： 文本, 图像 · 输出： 图像

快速开始

在你的 Comfy 工作区中创建一个密钥，并将其导出为 COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK（pip install comfy-sdk 和 npm install @comfyorg/sdk）；cURL 代码片段则是通过原始 HTTP 执行的同一调用。

模型 ID： runway/gen4_image

端点： POST https://api.comfy.org/v2/models/runway/gen4_image

[tab] 等待结果 ``python Python theme={null} from comfy_sdk import Comfy # 从环境变量中读取 COMFY_API_KEY。 # SDK 会自动创建幂等键，并在自动重试时复用它。 with Comfy() as client: result = client.models.run( "runway/gen4_image", { "promptText": "a red circle", "ratio": "1024:1024", }, ) print(result) ` `typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境变量中读取 COMFY_API_KEY。 // SDK 会自动创建幂等键，并在自动重试时复用它。 const { data } = await comfy.models.run("runway/gen4_image", { promptText: "a red circle", ratio: "1024:1024", }); console.log(data); ` `bash cURL theme={null} curl https://api.comfy.org/v2/models/runway/gen4_image \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"promptText\": \"a red circle\", \"ratio\": \"1024:1024\"}" ``
[tab] 排队并稍后收集 将相同的请求体发送到 POST https://api.comfy.org/v2/models/runway/gen4_image/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( "runway/gen4_image", { "promptText": "a red circle", "ratio": "1024:1024", }, ) 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("runway/gen4_image", { promptText: "a red circle", ratio: "1024:1024", }); 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/runway/gen4_image/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"promptText\": \"a red circle\", \"ratio\": \"1024:1024\"}" # 2. 轮询直到状态为 COMPLETED，每次响应都会指定需要等待的 Retry-After 秒数。 REQUEST_ID="<request_id from the 201 body>" curl -i https://api.comfy.org/v2/models/runway/gen4_image/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" # 3. 收集。完成时返回 200 和模型的原始输出，仍在运行时返回 202 和状态正文。 curl https://api.comfy.org/v2/models/runway/gen4_image/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY" ``

Schema

输入

model string

用于生成的模型。在 Comfy Router 路由 POST /v2/models/runway/{model} 上，此字段由路径提供，且绝不能发送；在 v1 POST /proxy/runway/text_to_image 路由上，该字段为必填，且限制为 gen4_image。

promptText string required

用于图像生成的文本提示词

ratio string required

可能的值：1920:1080, 1080:1920, 1024:1024, 1360:768, 1080:1080, 1168:880, 1440:1080, 1080:1440, 1808:768, 2112:912

referenceImages object[]

用于引导生成的参考图像数组

referenceImages\[].uri string required

包含编码图像的 HTTPS URL、Runway 上传 URI（runway://）或 data URI

由 Router 在 GET /v2/models/runway/gen4_image/openapi.json 提供的 schema 生成，这也是请求到达提供商之前它用于校验调用的同一份文档。

输出

createdAt string (date-time) required

任务创建时间戳

格式：date-time

id string required

任务 ID

output string[]

已完成生成的资源网址：对于 runway/gen4_image，每个元素都是一个 IMAGE URL。任务成功终止后才会出现；此列表就是结果。

progress number

介于 0 和 1 之间的浮点值，表示任务的进度。仅在状态为 RUNNING 时可用。

范围：0 到 1

格式：float

status string required

Runway 任务可能的状态。

可能的值：SUCCEEDED, RUNNING, FAILED, PENDING, CANCELLED, THROTTLED

示例

输入

{
  "promptText": "a red circle",
  "ratio": "1024:1024"
}

输出

{
  "createdAt": "2027-01-01T00:00:00Z",
  "id": "5f7c1b28-9a03-4e61-8d2f-1b2c3d4e5f60",
  "output": [
    "https://example.invalid/runway/gen4_image/generated.png"
  ],
  "status": "SUCCEEDED"
}

发布前须知

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 目前不支持的功能，以及替代方案。