将 Wan 2.5 T2I Preview 与 Comfy Router 配合使用
通过 Comfy Router 调用 wan/wan2.5-t2i-preview:端点、请求形状以及 Router 返回的响应。
将 Wan 2.5 T2I Preview 与 Comfy Router 配合使用
通过 Comfy Router 调用 wan/wan2.5-t2i-preview:端点、请求形状以及 Router 返回的响应。
wan/wan2.5-t2i-preview 的 API 参考,由 Comfy Router 从 Wan 提供服务。
输入: 文本 · 输出: 图像
快速开始
在你的 Comfy 工作区中创建一个密钥,并将其导出为 COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK(pip install comfy-sdk 和 npm install @comfyorg/sdk);cURL 代码片段则是通过原始 HTTP 进行的相同调用。
模型 ID: wan/wan2.5-t2i-preview
端点: POST https://api.comfy.org/v2/models/wan/wan2.5-t2i-preview
[tab] 等待结果 ``python Python theme={null} from comfy_sdk import Comfy # 从环境变量中读取 COMFY_API_KEY。 # SDK 会自动创建幂等键,并在自动重试时复用它。 with Comfy() as client: result = client.models.run( "wan/wan2.5-t2i-preview", { "input": { "prompt": "A single red maple leaf on a plain white background.", }, "parameters": { "n": 1, "size": "1280*1280", }, }, ) print(result)``typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境变量中读取 COMFY_API_KEY。 // SDK 会自动创建幂等键,并在自动重试时复用它。 const { data } = await comfy.models.run("wan/wan2.5-t2i-preview", { input: { prompt: "A single red maple leaf on a plain white background.", }, parameters: { n: 1, size: "1280*1280", }, }); console.log(data);``bash cURL theme={null} curl https://api.comfy.org/v2/models/wan/wan2.5-t2i-preview \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"input\": {\"prompt\":\"A single red maple leaf on a plain white background.\"}, \"parameters\": {\"n\":1,\"size\":\"1280*1280\"}}"``
[tab] 入队并稍后收集 将相同的请求体发送到POST https://api.comfy.org/v2/models/wan/wan2.5-t2i-preview/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( "wan/wan2.5-t2i-preview", { "input": { "prompt": "A single red maple leaf on a plain white background.", }, "parameters": { "n": 1, "size": "1280*1280", }, }, ) 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("wan/wan2.5-t2i-preview", { input: { prompt: "A single red maple leaf on a plain white background.", }, parameters: { n: 1, size: "1280*1280", }, }); 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/wan/wan2.5-t2i-preview/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"input\": {\"prompt\":\"A single red maple leaf on a plain white background.\"}, \"parameters\": {\"n\":1,\"size\":\"1280*1280\"}}" # 2. 轮询直到状态为 COMPLETED,按每个响应给出的 Retry-After 秒数等待。 REQUEST_ID="<request_id from the 201 body>" curl -i https://api.comfy.org/v2/models/wan/wan2.5-t2i-preview/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" # 3. 收集。返回 200 时携带模型的原生输出,仍在运行时返回 202 及状态响应体。 curl https://api.comfy.org/v2/models/wan/wan2.5-t2i-preview/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY"``
Schema
输入
input object required
输入基本信息,例如提示词等。
input.negative\_prompt string
反向提示词,用于描述你不希望在图像中出现的内容
input.prompt string required
正向提示词,用于描述期望的图像元素和视觉特征。支持中文和英文,长度不超过 800 个字符
model string
调用文生图生成时使用的模型 ID。此组件不对其做约束:Comfy Router 会从 POST /v2/models/wan/{model} 的 {model} 路径段中填充它。直接以 v1 方式调用 POST /proxy/wan/api/v1/services/aigc/text2image/image-synthesis 时必须提供该值,可接受的拼写枚举定义在该操作自身的组件 WanImageGenerationRequest 上。
parameters object
图像处理参数
parameters.n integer (default: 4)
生成图像的数量。范围 1-4,默认为 4
范围:1 到 4
parameters.prompt\_extend boolean (default: true)
启用提示词智能改写。默认为 true
parameters.seed integer
用于控制随机性的随机数种子。范围 \[0, 2147483647]
范围:0 到 2147483647
parameters.size string (default: "1280\*1280")
输出图像的分辨率,格式为 width*height。默认为 1280*1280。API 接受的像素面积在 1638400(1280*1280)到 2073600(1440*1440)之间,宽高比在 1:4 到 4:1 之间,因此 768\*2700 是有效的
parameters.watermark boolean (default: false)
是否在右下角添加水印标识
由 Router 在 GET /v2/models/wan/wan2.5-t2i-preview/openapi.json 提供的 schema 生成,该文档与请求到达提供商之前用于校验调用的文档相同。
输出
output object required
output.actual\_prompt string
智能改写后的实际提示词(用于视频任务)
output.check\_audio string
带音频生成的 I2V 任务的音频 URL
output.code string
失败请求的错误代码(请求成功时不返回)
output.end\_time string
任务完成时间
output.message string
失败请求的详细信息(请求成功时不返回)
output.orig\_prompt string
原始输入提示词(用于视频任务)
output.results object[]
图像生成任务的任务结果列表
output.results\[].actual\_prompt string
智能改写后的实际提示词(如果启用)
output.results\[].code string
图像错误代码(部分任务失败时返回)
output.results\[].message string
图像错误信息(部分任务失败时返回)
output.results\[].orig\_prompt string
原始输入提示词
output.results\[].url string
已生成图像的 URL 地址
output.scheduled\_time string
任务执行时间
output.submit\_time string
任务提交时间
output.task\_id string required
任务 ID
output.task\_metrics object
图像生成任务的任务结果统计
output.task\_metrics.FAILED integer
失败任务数
output.task\_metrics.SUCCEEDED integer
成功任务数
output.task\_metrics.TOTAL integer
任务总数
output.task\_status string required
任务状态
可能的值:PENDING、RUNNING、SUCCEEDED、FAILED、CANCELED、UNKNOWN
output.video\_url string
已完成的视频生成任务的视频 URL。链接有效期为 24 小时
request\_id string required
唯一请求标识符
usage object
输出信息统计。仅统计成功的结果
usage.SR integer
视频分辨率级别(I2V 和 wan3.0-video 任务)
usage.duration number
已生成视频的时长(秒)(I2V 和 wan3.0-video 任务)
usage.fps integer
已生成视频的帧率(wan3.0-video 任务)
usage.image\_count integer
已生成图像的数量(T2I 和 I2I 任务)
usage.input\_video\_duration number
输入视频的时长(秒),无视频输入时为 0.0(wan3.0-video 任务)
usage.output\_video\_duration number
输出视频的时长(秒)(wan3.0-video 任务)
usage.ratio string
已生成视频的宽高比,例如 16:9(wan3.0-video 任务)
usage.size string
图像分辨率(T2I 和 I2I 任务)
usage.video\_count integer
已生成视频的数量(T2V 任务)
usage.video\_duration number
已生成视频的时长(秒)(T2V 任务)
usage.video\_ratio string
视频分辨率比例(T2V 任务)
code string
失败请求的错误代码,报告在响应外层的根层级(ROOT),而非 output 下(请求成功时不返回)。
message string
失败请求的详细信息,报告在响应外层的根层级(ROOT),而非 output 下(请求成功时不返回)。在回退到 output.message 之前请先阅读此项。
示例
输入
{
"input": {
"prompt": "A single red maple leaf on a plain white background."
},
"parameters": {
"n": 1,
"size": "1280*1280"
}
}
输出
{
"output": {
"end_time": "2027-01-01T00:00:12.000Z",
"results": [
{
"actual_prompt": "a single red maple leaf resting on still water, shallow depth of field, soft morning light",
"orig_prompt": "a single red maple leaf resting on still water",
"url": "https://example.invalid/wan/generated-1.png"
},
{
"code": "DataInspectionFailed",
"message": "This candidate was rejected; the task as a whole succeeded.",
"orig_prompt": "a single red maple leaf resting on still water"
}
],
"scheduled_time": "2027-01-01T00:00:01.000Z",
"submit_time": "2027-01-01T00:00:00.000Z",
"task_id": "0385dc79-5ff8-4d82-bcb6-7c1a9f2e4d60",
"task_metrics": {
"FAILED": 1,
"SUCCEEDED": 1,
"TOTAL": 2
},
"task_status": "SUCCEEDED"
},
"request_id": "7574ee8f-38a3-4b1e-9280-11c33ab46e51",
"usage": {
"image_count": 1,
"size": "1280*1280"
}
}
发布前须知
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 目前不支持的功能,以及替代方案。