使用 Comfy Router 调用 Veo 3.1 Generate 001
通过 Comfy Router 调用 veo/veo-3.1-generate-001:端点、请求结构以及 Router 返回的响应。
使用 Comfy Router 调用 Veo 3.1 Generate 001
通过 Comfy Router 调用 veo/veo-3.1-generate-001:端点、请求结构以及 Router 返回的响应。
veo/veo-3.1-generate-001 的 API 参考,由 Comfy Router 从 Veo 提供。
输入: 文本, 图像, 视频 · 输出: 视频 + 音频
快速开始
在你的 Comfy 工作区中创建密钥,并将其导出为 COMFY_API_KEY。Python 和 TypeScript 片段使用 Comfy SDK(pip install comfy-sdk 和 npm install @comfyorg/sdk);cURL 片段则是通过原始 HTTP 发起同样的调用。
模型 ID: veo/veo-3.1-generate-001
端点: POST https://api.comfy.org/v2/models/veo/veo-3.1-generate-001
[tab] 等待结果 ``python Python theme={null} from comfy_sdk import Comfy # 从环境变量中读取 COMFY_API_KEY。 # SDK 会自动创建幂等键,并在自动重试时复用该键。 with Comfy() as client: result = client.models.run( "veo/veo-3.1-generate-001", { "instances": [ { "prompt": "a single red maple leaf falling onto still water, slow motion", }, ], "parameters": { "durationSeconds": 4, "generateAudio": False, "sampleCount": 1, }, }, ) print(result)``typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境变量中读取 COMFY_API_KEY。 // SDK 会自动创建幂等键,并在自动重试时复用该键。 const { data } = await comfy.models.run("veo/veo-3.1-generate-001", { instances: [ { prompt: "a single red maple leaf falling onto still water, slow motion", }, ], parameters: { durationSeconds: 4, generateAudio: false, sampleCount: 1, }, }); console.log(data);``bash cURL theme={null} curl https://api.comfy.org/v2/models/veo/veo-3.1-generate-001 \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"instances\": [{\"prompt\":\"a single red maple leaf falling onto still water, slow motion\"}], \"parameters\": {\"durationSeconds\":4,\"generateAudio\":false,\"sampleCount\":1}}"``
[tab] 提交到队列,稍后收集 相同的请求体,发送至POST https://api.comfy.org/v2/models/veo/veo-3.1-generate-001/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( "veo/veo-3.1-generate-001", { "instances": [ { "prompt": "a single red maple leaf falling onto still water, slow motion", }, ], "parameters": { "durationSeconds": 4, "generateAudio": False, "sampleCount": 1, }, }, ) 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("veo/veo-3.1-generate-001", { instances: [ { prompt: "a single red maple leaf falling onto still water, slow motion", }, ], parameters: { durationSeconds: 4, generateAudio: false, sampleCount: 1, }, }); console.log("requestId:", handle.requestId); // 加上模型 ID,就是另一个进程所需的全部信息 // 轮询直到请求完成,每次按服务器指定的 Retry-After 等待。 for await (const update of handle.events()) { console.log(update.status, update.queuePosition); } // 与 models.run() 返回的结果相同。失败或已取消的请求会在此处 reject。 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/veo/veo-3.1-generate-001/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"instances\": [{\"prompt\":\"a single red maple leaf falling onto still water, slow motion\"}], \"parameters\": {\"durationSeconds\":4,\"generateAudio\":false,\"sampleCount\":1}}" # 2. 轮询直到状态为 COMPLETED,每次按响应中指定的 Retry-After 秒数等待。 REQUEST_ID="<request_id from the 201 body>" curl -i https://api.comfy.org/v2/models/veo/veo-3.1-generate-001/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" # 3. 收集。返回 200 表示模型的原始输出,仍在运行时返回 202 和状态正文。 curl https://api.comfy.org/v2/models/veo/veo-3.1-generate-001/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY"``
Schema
输入
instances object[]
instances\[].cameraControl string
相机运动类型。需要提供图像。
可能的值:fixed、pan_left、pan_right、tilt_up、tilt_down、truck_left、truck_right、pedestal_up、pedestal_down、push_in、pull_out
instances\[].image object
可选的起始帧图像,用于引导视频生成
instances\[].image.bytesBase64Encoded string (byte)
Base64 编码的图像数据
格式:byte
instances\[].image.gcsUri string
图像的 Cloud Storage URI。在非 BYOK 请求中,若 gs:// URI(或其 https://storage.googleapis.com 形式)指向 Comfy 拥有的存储桶,则会以 400 拒绝;除非该对象位于你自己的 POST /customers/storage 前缀之下,或者它是一段此前某次 Veo 生成为你写入的视频。
instances\[].image.mimeType string
图像的 MIME 类型(image/jpeg 或 image/png)
可能的值:image/jpeg、image/png
instances\[].lastFrame object
可选的结束帧图像。与 image 一起使用,可在首帧与末帧之间生成视频。由 Veo 3.0+ 模型支持。
instances\[].lastFrame.bytesBase64Encoded string (byte)
Base64 编码的图像数据
格式:byte
instances\[].lastFrame.gcsUri string
图像的 Cloud Storage URI。在非 BYOK 请求中,若 gs:// URI(或其 https://storage.googleapis.com 形式)指向 Comfy 拥有的存储桶,则会以 400 拒绝;除非该对象位于你自己的 POST /customers/storage 前缀之下,或者它是一段此前某次 Veo 生成为你写入的视频。
instances\[].lastFrame.mimeType string
图像的 MIME 类型(image/jpeg 或 image/png)
可能的值:image/jpeg、image/png
instances\[].mask object
用于视频编辑的可选遮罩。应用于输入视频。
instances\[].mask.bytesBase64Encoded string (byte)
Base64 编码的遮罩字节数据
格式:byte
instances\[].mask.gcsUri string
遮罩文件的 Cloud Storage URI。在非 BYOK 请求中,若 gs:// URI(或其 https://storage.googleapis.com 形式)指向 Comfy 拥有的存储桶,则会以 400 拒绝;除非该对象位于你自己的 POST /customers/storage 前缀之下,或者它是一段此前某次 Veo 生成为你写入的视频。
instances\[].mask.maskMode string
遮罩的应用方式
可能的值:insert、remove、remove_static、outpaint
instances\[].mask.mimeType string
遮罩的 MIME 类型(image/png、image/jpeg、image/webp 或视频格式)
instances\[].prompt string required
要生成的视频的文本描述
instances\[].referenceImages object[]
用于引导视频生成的可选参考图像。最多支持 3 张素材图像或 1 张风格图像。由 Veo 3.1 模型(预览)支持。
instances\[].referenceImages\[].image object required
instances\[].referenceImages\[].image.bytesBase64Encoded string (byte)
Base64 编码的图像数据
格式:byte
instances\[].referenceImages\[].image.gcsUri string
图像的 Cloud Storage URI。在非 BYOK 请求中,若 gs:// URI(或其 https://storage.googleapis.com 形式)指向 Comfy 拥有的存储桶,则会以 400 拒绝;除非该对象位于你自己的 POST /customers/storage 前缀之下,或者它是一段此前某次 Veo 生成为你写入的视频。
instances\[].referenceImages\[].image.mimeType string
图像的 MIME 类型(image/jpeg 或 image/png)
可能的值:image/jpeg、image/png
instances\[].referenceImages\[].referenceId string
参考图像的可选标识符
instances\[].referenceImages\[].referenceType string required
参考图像的类型
可能的值:asset、style
instances\[].video object
用于视频扩展或编辑的可选输入视频。与 image 和 referenceImages 不兼容。
instances\[].video.bytesBase64Encoded string (byte)
Base64 编码的视频字节数据
格式:byte
instances\[].video.gcsUri string
输入视频的 Cloud Storage URI。在非 BYOK 请求中,若 gs:// URI(或其 https://storage.googleapis.com 形式)指向 Comfy 拥有的存储桶,则会以 400 拒绝;除非该对象位于你自己的 POST /customers/storage 前缀之下,或者它是一段此前某次 Veo 生成为你写入的视频。
instances\[].video.mimeType string
视频的 MIME 类型
可能的值:video/mov、video/mpeg、video/mp4、video/mpg、video/avi、video/wmv、video/mpegps、video/x-flv
parameters object
parameters.aspectRatio string
生成视频的宽高比。默认值:16:9
可能的值:16:9、9:16
parameters.compressionQuality string
视频压缩质量。默认值:optimized
可能的值:optimized、lossless
parameters.durationSeconds number
生成视频的目标时长(秒)。Veo 2:5-8。Veo 3/3.1:4、6 或 8。默认值:8
parameters.enhancePrompt boolean
自动改进提示词以获得更高质量。默认值为 true。
parameters.fps integer
生成视频的帧率,单位为帧每秒
parameters.generateAudio boolean
是否随视频一起生成音频。默认值为 true。由 Veo 3.0+ 模型支持。
parameters.negativePrompt string
描述已生成视频中应避免出现内容的文本
parameters.personGeneration string
控制已生成视频中的人物。默认值:allow\_adult
可选值:dont_allow、allow_adult、allowAll
parameters.pubsubTopic string
用于进度更新的 Cloud Pub/Sub 主题(projects/\{project}/topics/\{topic})。使用 Comfy 凭据(非自带密钥)的请求不接受此项:如果请求中存在该字段,generate 路由会返回 400,因为该操作在 Comfy 的项目中运行,Vertex 会以 Comfy 的服务代理身份发布。仅在自带密钥请求中被接受,此时 Vertex 会在你自己的项目中评估该主题的授权。
parameters.resizeMode string
输入图像的调整大小方式。默认值:pad
可选值:pad、crop
parameters.resolution string
输出视频分辨率。由 Veo 3.0+ 模型支持。默认值:720p
可选值:720p、1080p、4k
parameters.sampleCount integer
要生成的视频数量。如果未指定,则生成 1 个视频。
范围:1 到 4
parameters.seed integer
用于确定性输出的随机种子。如果 sampleCount > 1,则每个视频使用不同的种子。
格式:uint32
parameters.storageUri string
可选的、用于存放已生成视频的 Cloud Storage 目标位置,以 gs:// URI 表示。 它必须指向你自己的存储桶。在非自带密钥(bring-your-own-key)的情况下,此路由使用 Comfy 自己的 Google Cloud 凭据而不是你的凭据运行,因此指向 Comfy 拥有存储桶的目标位置会变成由 Comfy 服务账号执行的写入,落到共享布局中,并计入 Comfy 的项目费用。指定此类目标位置的请求会以 400 被拒绝,且不会生成任何内容;唯一例外是启用了平台存储的同步 Comfy Router 调用(POST /v2/models/{provider}/{model}):若值指向 Router 自己的 Veo 或 Gemini 资产存储桶,则会替换为 Router 为该次调用在你自己的平台前缀下铸造的目标位置(参见 Router Veo 路由),并且只有该确切由 Router 铸造的目标位置会放行。排队的 Router 提交(POST /v2/models/{provider}/{model}/requests)不会做这种替换,因此会像对待任何其他 Comfy 拥有的存储桶一样,以 400 拒绝该值。任何其他目标位置都会原样转发给 Vertex,访问权限由你自行授予。自带密钥的调用在你自己的项目中运行,并按发送内容原样转发。
parameters.task string
视频生成请求的操作类型
可选值:textToVideo、imageToVideo、referenceToVideo、edit、extend、upscale
该文档由 Router 在 GET /v2/models/veo/veo-3.1-generate-001/openapi.json 提供,同样也是请求到达提供商之前用于校验调用的文档。
输出
done boolean
操作是否已完成
error object
错误详情,操作失败时存在
error.code integer
gRPC 错误码
error.message string
报错信息
name string
操作资源名称
response object
预测响应,当 done 为 true 时存在
response.\@type string
response.raiMediaFilteredCount integer
被负责任 AI 策略过滤的视频数量
response.raiMediaFilteredReasons string[]
视频被负责任 AI 策略过滤的原因
response.videos object[]
response.videos\[].bytesBase64Encoded string
Base64 编码的视频内容
response.videos\[].gcsUri string
已生成视频的 Cloud Storage URI
response.videos\[].mimeType string
视频 MIME 类型(video/mp4)
示例
输入
{
"instances": [
{
"prompt": "a single red maple leaf falling onto still water, slow motion"
}
],
"parameters": {
"durationSeconds": 4,
"generateAudio": false,
"sampleCount": 1
}
}
输出
{
"done": true,
"name": "projects/example-project/locations/us-central1/publishers/google/models/veo-3.1-fast-generate-001/operations/1a2b3c4d",
"response": {
"@type": "type.googleapis.com/cloud.ai.large_models.vision.GenerateVideoResponse",
"raiMediaFilteredCount": 0,
"videos": [
{
"gcsUri": "https://storage.googleapis.com/EXAMPLE_BUCKET/veo/USER_ID/REQUEST_ID/sample_0.mp4",
"mimeType": "video/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。
[card] 请求头 身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。
[card] 使用 Router API 模型发现、验证错误、重试与计费。
[card] 限制 Router 目前不支持的功能,以及替代方案。