使用 V6 与 Comfy Router
通过 Comfy Router 调用 pixverse/v6:端点、请求形状以及 Router 返回的响应。
使用 V6 与 Comfy Router
通过 Comfy Router 调用 pixverse/v6:端点、请求形状以及 Router 返回的响应。
pixverse/v6 的 API 参考,由 Comfy Router 从 Pixverse 提供。
输入: 文本 · 输出: 视频
快速开始
在你的 Comfy 工作区中创建密钥,并把它导出为 COMFY_API_KEY。Python 和 TypeScript 片段使用 Comfy SDK(pip install comfy-sdk 和 npm install @comfyorg/sdk);cURL 片段则是通过原始 HTTP 发出的同一调用。
模型 ID: pixverse/v6
端点: POST https://api.comfy.org/v2/models/pixverse/v6
等待结果 ``python Python theme={null} from comfy_sdk import Comfy # 从环境变量读取 COMFY_API_KEY。 # SDK 会自动创建幂等键,并在自动重试时复用它。 with Comfy() as client: result = client.models.run( "pixverse/v6", { "aspect_ratio": "16:9", "duration": 5, "prompt": "a single red maple leaf falling onto still water", "quality": "360p", }, ) print(result)``typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境变量读取 COMFY_API_KEY。 // SDK 会自动创建幂等键,并在自动重试时复用它。 const { data } = await comfy.models.run("pixverse/v6", { aspect_ratio: "16:9", duration: 5, prompt: "a single red maple leaf falling onto still water", quality: "360p", }); console.log(data);``bash cURL theme={null} curl https://api.comfy.org/v2/models/pixverse/v6 \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"aspect_ratio\": \"16:9\", \"duration\": 5, \"prompt\": \"a single red maple leaf falling onto still water\", \"quality\": \"360p\"}"``
先排队,稍后收取 同一个请求体,发送到POST https://api.comfy.org/v2/models/pixverse/v6/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( "pixverse/v6", { "aspect_ratio": "16:9", "duration": 5, "prompt": "a single red maple leaf falling onto still water", "quality": "360p", }, ) 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("pixverse/v6", { aspect_ratio: "16:9", duration: 5, prompt: "a single red maple leaf falling onto still water", quality: "360p", }); 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/pixverse/v6/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"aspect_ratio\": \"16:9\", \"duration\": 5, \"prompt\": \"a single red maple leaf falling onto still water\", \"quality\": \"360p\"}" # 2. 轮询直到状态为 COMPLETED,每次响应中按 Retry-After 指定的秒数等待。 REQUEST_ID="<request_id from the 201 body>" curl -i https://api.comfy.org/v2/models/pixverse/v6/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" # 3. 收取。200 返回模型的原生输出,仍在运行时则返回 202 和状态响应体。 curl https://api.comfy.org/v2/models/pixverse/v6/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY"``
Schema
输入
aspect\_ratio string required
可选值:16:9、4:3、1:1、3:4、9:16、2:3、3:2、21:9
duration integer required
范围:1 到 15
generate\_audio\_switch boolean (default: false)
model string
PixVerse 文生视频模型标识符。在 Comfy Router 的 POST /v2/models/pixverse/{model} 路由上,此字段由路径提供,可以省略。
motion\_mode string
可选值:normal、fast
negative\_prompt string
prompt string required
quality string required
可选值:360p、540p、720p、1080p
seed integer
style string
可选值:anime、3d_animation、clay、comic、cyberpunk
template\_id integer
water\_mark boolean
该内容根据 Router 在 GET /v2/models/pixverse/v6/openapi.json 提供的 schema 生成,该文档也是 Router 在请求到达提供商之前用于校验调用的同一份文档。
输出
ErrCode integer
ErrMsg string
Resp object required
Resp.create\_time string
Resp.credits integer
Resp.id integer
Resp.modify\_time string
Resp.negative\_prompt string
Resp.outputHeight integer
Resp.outputWidth integer
Resp.prompt string
Resp.resolution\_ratio integer
Resp.seed integer
Resp.size integer
Resp.status integer required
可选值:1、5、6、7、8
Resp.style string
Resp.url string required
示例
输入
{
"aspect_ratio": "16:9",
"duration": 5,
"prompt": "a single red maple leaf falling onto still water",
"quality": "360p"
}
输出
{
"ErrCode": 0,
"ErrMsg": "",
"Resp": {
"credits": 1,
"id": 4242,
"status": 1,
"url": "https://example.invalid/pixverse/v6/out.mp4"
}
}
发布前须知
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 目前不支持的功能,以及替代方案。