快速开始
在你的 Comfy 工作区中创建一个密钥,并将其导出为COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK(pip install comfy-sdk 和 npm install @comfyorg/sdk);cURL 代码片段则是通过原始 HTTP 进行的相同调用。
模型 ID: vertexai/gemini-3-pro-image
端点: POST https://api.comfy.org/v2/models/vertexai/gemini-3-pro-image
- 等待结果
- 排队并稍后收集
将同样的请求体发送到
POST https://api.comfy.org/v2/models/vertexai/gemini-3-pro-image/requests。运行一旦被受理,Router 会立即返回 201 和 request_id;结果就绪后,就可以从当前进程或另一个进程中收集它。队列投递 会逐步介绍状态查询、取消和收集。服务提供商
除非请求指定了其他提供商,否则该模型由 Comfy Router 直接提供服务。以下提供商也在同一端点和相同的模型 ID 下提供该模型,可通过model_provider 查询参数选择。
- Comfy(默认):
POST https://api.comfy.org/v2/models/vertexai/gemini-3-pro-image - fal,以
fal/fal-nano-banana-pro提供:POST https://api.comfy.org/v2/models/vertexai/gemini-3-pro-image?model_provider=fal - Runware,以
runware/runware-nano-banana-pro提供:POST https://api.comfy.org/v2/models/vertexai/gemini-3-pro-image?model_provider=runware - WaveSpeed,以
wavespeed/wavespeed-nano-banana-pro提供:POST https://api.comfy.org/v2/models/vertexai/gemini-3-pro-image?model_provider=wavespeed
strict_mode 默认为 false,因此 Router 会将本页记录的原始请求体转换为提供商自己的 schema,并将响应转换回来。请参阅 API 参考中的 model_provider、strict_mode 和 fallback_provider,以及 服务提供商 了解所有以此方式路由的模型。
Schema
输入
object[]
必填
与模型当前对话的内容。对于单轮查询,这是一个单独的实例。对于多轮查询,这是一个重复字段,包含对话历史和最新请求。
object[]
必填
object
基于 URI 的数据。
string
URI
string
在 data 或 fileUri 字段中指定的文件的媒体类型。可接受的值包括以下内容。对于 gemini-2.0-flash-lite 和 gemini-2.0-flash,音频文件的最大长度为 8.4 小时,视频文件(无音频)的最大长度为一小时。有关详细信息,请参阅 Gemini 音频和视频要求。文本文件必须采用 UTF-8 编码。文本文件的内容计入 token 上限。图像分辨率没有限制。可能的值:
application/pdf、audio/mpeg、audio/mp3、audio/wav、image/png、image/jpeg、image/webp、text/plain、video/mov、video/mpeg、video/mp4、video/mpg、video/avi、video/wmv、video/mpegps、video/flv、image/heic、image/heif、audio/flac、video/webmobject
以原始字节表示的内联数据。对于 gemini-2.0-flash-lite 和 gemini-2.0-flash,通过 inlineData 最多可以指定 3000 张图像。
string (byte)
要在提示词中以内联方式包含的图像、PDF 或视频的 base64 编码。以内联方式包含媒体时,还必须指定数据的媒体类型 (mimeType)。大小限制:20MB格式:
bytestring
在 data 或 fileUri 字段中指定的文件的媒体类型。可接受的值包括以下内容。对于 gemini-2.0-flash-lite 和 gemini-2.0-flash,音频文件的最大长度为 8.4 小时,视频文件(无音频)的最大长度为一小时。有关详细信息,请参阅 Gemini 音频和视频要求。文本文件必须采用 UTF-8 编码。文本文件的内容计入 token 上限。图像分辨率没有限制。可能的值:
application/pdf、audio/mpeg、audio/mp3、audio/wav、image/png、image/jpeg、image/webp、text/plain、video/mov、video/mpeg、video/mp4、video/mpg、video/avi、video/wmv、video/mpegps、video/flv、image/heic、image/heif、audio/flac、video/webmstring
模型如何读取此部分的视频。设置为 “AGENTIC” 可让模型自行决定要检查哪些片段,而不是采用固定速率的帧采样。省略则使用默认的固定速率采样。gemini-3.7-flash 及更新的 Flash 模型支持此参数。
string
文本提示词或代码片段。
boolean
表示此部分是模型的一个思考/推理步骤。
string
可能的值:
user、modelobject
生成的采样、长度和输出设置。每个字段都是可选的:下面声明了
default 的字段在省略时会应用该默认值,其余字段则回退到模型自身的行为。object
图像生成的配置
string
已生成图像的宽高比
object
可选。已生成图像的图像输出格式。
integer
可选。输出图像的压缩质量。
string
可选。输出应保存为的图像格式。
string
可选。指定已生成图像的尺寸。支持的值为 1K、2K、4K。如果未指定,模型将使用默认值 1K。
integer
响应中最多可以生成的 token 数量。一个 token 大约相当于 4 个字符。100 个 token 大致对应 60-80 个单词。范围:
16 到 65536`TEXT`, `IMAGE`[]
integer
当种子固定为特定值时,模型会尽最大努力对重复的请求提供相同的响应。但无法保证输出具有确定性。此外,更改模型或参数设置(例如 temperature)可能会导致响应发生变化,即使使用相同的种子值也是如此。默认情况下,使用随机种子值。适用于以下模型:, gemini-2.5-flash, gemini-2.5-pro, gemini-2.5-flash-preview-04-1, gemini-2.5-pro-preview-05-0, gemini-2.0-flash-lite-00, gemini-2.0-flash-001
string[]
number
默认值:"1"
temperature 用于响应生成期间的采样,当应用 topP 和 topK 时会发生采样。temperature 控制 token 选择中的随机程度。较低的 temperature 适合要求响应不那么开放或富有创造性的提示词,而较高的 temperature 则可能带来更多样或更有创造性的结果。temperature 为 0 表示始终选择概率最高的 token。在这种情况下,给定提示词的响应大多是确定性的,但仍可能有少量变化。如果模型返回的响应过于通用、过于简短,或者模型给出的是兜底响应,请尝试提高 temperature范围:
0 到 2格式: floatobject
可选。思考功能的配置。思考是模型将复杂任务分解为更小步骤以生成更高质量响应的过程。
boolean
可选。如果为 true,模型将在响应中包含其思考内容。
integer
可选。模型思考过程的 token 预算。模型将尽力保持在此预算之内。
string
可选。模型的思考级别。可能的值:
THINKING_LEVEL_UNSPECIFIED、LOW、MEDIUM、HIGH、MINIMALinteger
默认值:"40"
Top-K 改变模型为输出选择 token 的方式。Top-K 为 1 意味着下一个被选择的 token 是模型词表中所有 token 里概率最高的。Top-K 为 3 意味着下一个 token 会通过 temperature 从概率最高的 3 个 token 中选出。范围:
1 到 …number
默认值:"0.95"
如果指定,则使用核采样。
Top-P 改变模型为输出选择 token 的方式。token 会从概率最高(参见 top-K)到概率最低依次选择,直到它们的概率之和等于 top-P 值。例如,如果 token A、B 和 C 的概率分别为 0.3、0.2 和 0.1,而 top-P 值为 0.5,则模型会通过 temperature 选择 A 或 B 作为下一个 token,并将 C 排除在候选之外。
指定较低的值可获得随机性更低的响应,较高的值可获得随机性更高的响应。范围:
0 到 1格式: floatobject[]
用于阻止不安全内容的按请求设置。在 GenerateContentResponse.candidates 上强制执行。
string
必填
可能的值:
HARM_CATEGORY_SEXUALLY_EXPLICIT、HARM_CATEGORY_HATE_SPEECH、HARM_CATEGORY_HARASSMENT、HARM_CATEGORY_DANGEROUS_CONTENTstring
必填
可能的值:
OFF、BLOCK_NONE、BLOCK_LOW_AND_ABOVE、BLOCK_MEDIUM_AND_ABOVE、BLOCK_ONLY_HIGHobject
用于引导模型实现更佳表现的指令。例如,“尽可能简洁地回答”或”回答中不要使用技术术语”。文本字符串会计入 token 限制。systemInstruction 的 role 字段会被忽略,且不影响模型的表现。注意:parts 中应仅使用文本,且每个 part 中的内容应单独成段。
object[]
必填
构成单条消息的有序 parts 列表。不同的 part 可以具有不同的 IANA MIME 类型。有关输入的限制,例如最大 token 数或图像数量,请参阅 Google models 页面上的模型规格。
string
文本提示词或代码片段。
string
创建该消息的实体的身份。支持以下值:user:表示该消息由真实的人发送,通常是用户生成的消息。model:表示该消息由模型生成。在多轮对话期间,使用 model 值可将来自模型的消息插入对话中。对于非多轮对话,此字段可留空或不设置。可能的值:
user、modelobject[]
一段代码,使系统能够与外部系统交互,以执行模型知识范围之外的某个操作或一组操作。请参阅函数调用。
object[]
string
string
必填
object
函数参数的 JSON schema
boolean
如果为 true,已生成的图像将上传到云端存储,并作为签名 URL 返回,而不是内联 base64 数据。这些 URL 将在 24 小时后过期。
object
对于视频输入,表示视频的起始和结束偏移量,采用 Duration 格式。例如,要指定从 1:00 开始的 10 秒片段,请设置 “startOffset”: { “seconds”: 60 } 和 “endOffset”: { “seconds”: 70 }。只有在视频数据以 inlineData 或 fileData 形式呈现时,才应指定该元数据。
object
表示视频时间轴位置的时长偏移。
integer
以纳秒为分辨率的有符号秒的小数部分。带有小数的负的秒值,其 nanos 值仍必须为非负。范围:
0 到 999999999integer
时间段的有符号秒数。必须介于 -315,576,000,000 到 +315,576,000,000 之间(含边界值)。范围:
-315576000000 到 315576000000object
表示视频时间轴位置的时长偏移。
integer
以纳秒为分辨率的有符号秒的小数部分。带有小数的负的秒值,其 nanos 值仍必须为非负。范围:
0 到 999999999integer
时间段的有符号秒数。必须介于 -315,576,000,000 到 +315,576,000,000 之间(含边界值)。范围:
-315576000000 到 315576000000GET /v2/models/vertexai/gemini-3-pro-image/openapi.json 提供的 schema 生成,该文档也是请求到达提供商之前 Router 用于校验调用的同一份文档。
输出
object[]
object
object[]
string[]
integer
string
string (date)
格式:
dateinteger
string
string
object
与模型进行的当前对话的内容。对于单轮查询,这是一个单独的实例。对于多轮查询,这是一个重复字段,包含对话历史和最新的请求。
object[]
必填
object
基于 URI 的数据。
string
URI
string
在 data 或 fileUri 字段中指定的文件的媒体类型。可接受的取值包括以下内容。对于 gemini-2.0-flash-lite 和 gemini-2.0-flash,音频文件的最大长度为 8.4 小时,视频文件(不含音频)的最大长度为一小时。更多信息请参阅 Gemini 音频和视频要求。文本文件必须使用 UTF-8 编码。文本文件的内容计入 token 限制。图像分辨率无限制。可能的值:
application/pdf、audio/mpeg、audio/mp3、audio/wav、image/png、image/jpeg、image/webp、text/plain、video/mov、video/mpeg、video/mp4、video/mpg、video/avi、video/wmv、video/mpegps、video/flv、image/heic、image/heif、audio/flac、video/webmobject
以原始字节形式内联的数据。对于 gemini-2.0-flash-lite 和 gemini-2.0-flash,使用 inlineData 最多可以指定 3000 张图像。
string (byte)
要内联包含在提示中的图像、PDF 或视频的 base64 编码。内联包含媒体时,还必须指定数据的媒体类型(mimeType)。大小限制:20MB格式:
bytestring
在 data 或 fileUri 字段中指定的文件的媒体类型。可接受的取值包括以下内容。对于 gemini-2.0-flash-lite 和 gemini-2.0-flash,音频文件的最大长度为 8.4 小时,视频文件(不含音频)的最大长度为一小时。更多信息请参阅 Gemini 音频和视频要求。文本文件必须使用 UTF-8 编码。文本文件的内容计入 token 限制。图像分辨率无限制。可能的值:
application/pdf、audio/mpeg、audio/mp3、audio/wav、image/png、image/jpeg、image/webp、text/plain、video/mov、video/mpeg、video/mp4、video/mpg、video/avi、video/wmv、video/mpegps、video/flv、image/heic、image/heif、audio/flac、video/webmstring
模型如何读取此部分的视频。设置为 “AGENTIC” 可让模型自行决定检查哪些片段,而不是按固定帧率采样。省略则使用默认的固定帧率采样。在 gemini-3.7-flash 及更新的 Flash 模型上支持。
string
文本提示或代码片段。
boolean
表示此部分是模型的思考/推理步骤。
string
可能的值:
user、modelstring
object[]
string
可能的值:
HARM_CATEGORY_SEXUALLY_EXPLICIT、HARM_CATEGORY_HATE_SPEECH、HARM_CATEGORY_HARASSMENT、HARM_CATEGORY_DANGEROUS_CONTENTstring
内容违反指定安全类别的概率可能的值:
NEGLIGIBLE、LOW、MEDIUM、HIGH、UNKNOWNstring
响应创建时的时间戳。
string
用于生成响应的模型版本。
object
string
string
object[]
string
可能的值:
HARM_CATEGORY_SEXUALLY_EXPLICIT、HARM_CATEGORY_HATE_SPEECH、HARM_CATEGORY_HARASSMENT、HARM_CATEGORY_DANGEROUS_CONTENTstring
内容违反指定安全类别的概率可能的值:
NEGLIGIBLE、LOW、MEDIUM、HIGH、UNKNOWNstring
响应的唯一标识符。
object
integer
仅输出。输入中缓存部分(缓存内容)的 token 数量。
integer
响应中的 token 数量。
object[]
按模态划分的候选 token 明细。
string
输入或输出内容模态的类型。可能的值:
MODALITY_UNSPECIFIED、TEXT、IMAGE、VIDEO、AUDIO、DOCUMENTinteger
给定模态的 token 数量。
integer
请求中的 token 数量。设置 cachedContent 后,这仍是提示词的有效总大小,也就是说其中包含缓存内容中的 token 数量。
object[]
按模态划分的提示词 token 明细。
string
输入或输出内容模态的类型。可能的值:
MODALITY_UNSPECIFIED、TEXT、IMAGE、VIDEO、AUDIO、DOCUMENTinteger
给定模态的 token 数量。
integer
思考输出中包含的 token 数量。
integer
工具使用提示词中包含的 token 数量。
object[]
按模态划分的工具使用提示词 token 明细。
string
输入或输出内容模态的类型。可能的值:
MODALITY_UNSPECIFIED、TEXT、IMAGE、VIDEO、AUDIO、DOCUMENTinteger
给定模态的 token 数量。
integer
token 总数(提示词 + 候选)。
string
用于该请求的流量类型(例如 PROVISIONED_THROUGHPUT)。
示例
输入
输出
读取 parts
默认情况下,已生成的图像 part 会在inlineData.data 中包含 base64 字节,并在 inlineData.mimeType 中包含媒体类型。解码这些字节并将其保存到文件。当设置 uploadImagesToStorage: true 时,上传的图像改用 fileData.fileUri 提供签名 URL,用 fileData.mimeType 提供媒体类型。请在这些 URL 过期之前下载这些图像,它们自创建起 24 小时后过期。
fileData 可能出现在并未请求它的响应中。 这两种形状是按 part 而非按响应决定的:当设置了 uploadImagesToStorage: true 时,上传失败的图像会保留为 inlineData,因此同一个响应中可以混用两者。应依据实际存在的键来分支处理,而不是依据你请求了什么。唯一不可能出现的情况恰好相反:当该字段未设置或为 false 时,每个已生成的图像都会以 inlineData 返回,不会产生任何 fileData 图像 part。也可能出现文本 part,并且图像不保证是第一个 part,因此应根据你需要的字段来选择 part,而不是按索引。上面快速入门示例中的 candidates[0].content.parts[0].inlineData.data 路径读取的是本页示例响应中唯一的内联 part;面对真实响应时,应扫描 parts 查找你想要的键,而不是索引位置 0。
thoughtSignature 也是一个 part 字段,而且它很大。 一个 part 可以携带 thoughtSignature,这是模型推理过程的不透明 base64 签名,其存在是为了让该思维过程能在后续请求中被重放。它未出现在上面的已生成 schema 中,该 schema 遵循 Router 发布的请求/响应文档。在实际响应中实测,它每个 part 大约为 1 到 2 MB,与图像本身相当,因此如果你要记录响应日志、通过无服务器函数转发响应或存储响应,就值得为其预留空间或将其显式丢弃。
imageSize 是一个档位,而不是宽度
generationConfig.imageConfig.imageSize 接受 1K、2K 或 4K,每提升一档都会将两条边都翻倍,而不是设定某个宽度。一个 16:9 的请求在 1K 下实测为 1376x768、约 1.35 MB,在 2K 下为 2752x1536、约 5.6 MB:相同的宽高比,四倍的像素,大约四倍的字节数。因此 2K 并不意味着 2048 像素宽的图像,如果把 2K 当作宽度来规划上传路径、响应体限制或存储桶容量,会导致资源不足约四倍。
参考图串联
将上一个已生成的图像直接传回,可以在同一主体上获得新的相机角度,因此对同一场景的一系列拍摄是一连串调用,而不是一个必须一次性描述所有内容的提示词。架构、材质和光照常常能在串联中延续,但模型并不保证这一点;请把连续性视为一个需要检查的可能结果,而不是可以依赖的属性。 请按上一个响应使用的形状把图像传回。对于inlineData part,从 inlineData.data 取出 base64 字节,并将其原样作为 inlineData 发送,如下所示。对于在 uploadImagesToStorage: true 下以 fileData 返回的 part,在签名 URL 仍然有效时,改为将其 fileData.fileUri 和 fileData.mimeType 作为 fileData part 发送;把字节重新上传为 inlineData 同样可行,且不会过期。然后提出你想要的改动:
2K 图像的字节数大约是 1K 的四倍。
发布前须知
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 目前不支持的功能,以及替代方案。