ComfyPilotComfyPilot
文档 / 开发 / 将 Nano Banana 2 与 Comfy Router 配合使用

将 Nano Banana 2 与 Comfy Router 配合使用

通过 Comfy Router 以 HTTP 方式调用 Nano Banana 2（Gemini 3.1 Flash Image）生成图像的 Python、TypeScript 和 cURL 代码片段，以及请求字段和返回结果结构

开发 code 更新于 2026-11-09

查看官方原文

将 Nano Banana 2 与 Comfy Router 配合使用

通过 Comfy Router 以 HTTP 方式调用 Nano Banana 2（Gemini 3.1 Flash Image）生成图像的 Python、TypeScript 和 cURL 代码片段，以及请求字段和返回结果结构

Nano Banana 2 的 API 参考。Nano Banana 2（Gemini 3.1 Flash Image）可根据文本生成图像，并在提供输入图像时对其进行编辑。

输入： 文本, 图像, 视频 · 输出： 图像 + 文本

快速开始

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

模型 ID： vertexai/gemini-3.1-flash-image

端点： POST https://api.comfy.org/v2/models/vertexai/gemini-3.1-flash-image

[tab] 等待结果 ``python Python theme={null} import asyncio from comfy_sdk import AsyncComfy # 从环境中读取 COMFY_API_KEY。 # SDK 会自动创建幂等键，并在自动重试时复用它。 async def main(): async with AsyncComfy() as client: result = await client.models.run( "vertexai/gemini-3.1-flash-image", { "contents": [ { "role": "user", "parts": [ { "text": "a single red maple leaf on a plain white background, studio lighting", }, ], }, ], "generationConfig": { "responseModalities": ["IMAGE"], "imageConfig": { "aspectRatio": "1:1", }, }, }, ) print("image (base64):", result["candidates"][0]["content"]["parts"][0]["inlineData"]["data"]) asyncio.run(main()) ` `typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境中读取 COMFY_API_KEY。 // SDK 会自动创建幂等键，并在自动重试时复用它。 type Result = { candidates: { content: { parts: { inlineData: { data: string } }[] } }[] }; const result = await comfy.models.run<Result>("vertexai/gemini-3.1-flash-image", { contents: [ { role: "user", parts: [ { text: "a single red maple leaf on a plain white background, studio lighting", }, ], }, ], generationConfig: { responseModalities: ["IMAGE"], imageConfig: { aspectRatio: "1:1", }, }, }); if (result.kind !== "json") throw new Error("expected a JSON result"); console.log("image (base64):", result.data.candidates[0].content.parts[0].inlineData.data); ` `bash cURL theme={null} curl https://api.comfy.org/v2/models/vertexai/gemini-3.1-flash-image \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"contents\": [{\"role\":\"user\",\"parts\":[{\"text\":\"a single red maple leaf on a plain white background, studio lighting\"}]}], \"generationConfig\": {\"responseModalities\":[\"IMAGE\"],\"imageConfig\":{\"aspectRatio\":\"1:1\"}}}" ``
[tab] 加入队列并稍后收集 同样的请求体，发送到 POST https://api.comfy.org/v2/models/vertexai/gemini-3.1-flash-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( "vertexai/gemini-3.1-flash-image", { "contents": [ { "role": "user", "parts": [ { "text": "a single red maple leaf on a plain white background, studio lighting", }, ], }, ], "generationConfig": { "responseModalities": ["IMAGE"], "imageConfig": { "aspectRatio": "1: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("image (base64):", result["candidates"][0]["content"]["parts"][0]["inlineData"]["data"]) asyncio.run(main()) ` `typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境变量中读取 COMFY_API_KEY。 // 每次 submit() 调用都会生成自己的 Idempotency-Key，并在自动重试时复用它。 type Result = { candidates: { content: { parts: { inlineData: { data: string } }[] } }[] }; const handle = await comfy.models.submit<Result>("vertexai/gemini-3.1-flash-image", { contents: [ { role: "user", parts: [ { text: "a single red maple leaf on a plain white background, studio lighting", }, ], }, ], generationConfig: { responseModalities: ["IMAGE"], imageConfig: { aspectRatio: "1:1", }, }, }); 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(); if (result.kind !== "json") throw new Error("expected a JSON result"); console.log("image (base64):", result.data.candidates[0].content.parts[0].inlineData.data); ` `bash cURL theme={null} # 1. 提交。Router 返回 201，并带上 request_id、status_url、response_url 和 cancel_url。 curl https://api.comfy.org/v2/models/vertexai/gemini-3.1-flash-image/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"contents\": [{\"role\":\"user\",\"parts\":[{\"text\":\"a single red maple leaf on a plain white background, studio lighting\"}]}], \"generationConfig\": {\"responseModalities\":[\"IMAGE\"],\"imageConfig\":{\"aspectRatio\":\"1:1\"}}}" # 2. 轮询直到状态为 COMPLETED，每次等待响应中指定的 Retry-After 秒数。 REQUEST_ID="<request_id from the 201 body>" curl -i https://api.comfy.org/v2/models/vertexai/gemini-3.1-flash-image/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" # 3. 收集。完成后返回 200 和模型的原生输出，仍在运行时返回 202 和状态体。 curl https://api.comfy.org/v2/models/vertexai/gemini-3.1-flash-image/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY" ``

服务提供商

除非请求指定了其他提供商，否则该模型由 Comfy Router 直接提供服务。以下提供商同样可以提供该模型，它们使用相同的端点和相同的模型 ID，通过 model_provider 查询参数进行选择。

  • Comfy（默认）：POST https://api.comfy.org/v2/models/vertexai/gemini-3.1-flash-image
  • fal，即 fal/fal-nano-banana-2：POST https://api.comfy.org/v2/models/vertexai/gemini-3.1-flash-image?model_provider=fal
  • MiniMax，即 minimax/minimax-nano-banana-2：POST https://api.comfy.org/v2/models/vertexai/gemini-3.1-flash-image?model_provider=minimax
  • Pika，即 pika/pika-nano-banana-2：POST https://api.comfy.org/v2/models/vertexai/gemini-3.1-flash-image?model_provider=pika
  • Runware，即 runware/runware-nano-banana-2：POST https://api.comfy.org/v2/models/vertexai/gemini-3.1-flash-image?model_provider=runware
  • WaveSpeed，即 wavespeed/wavespeed-nano-banana-2：POST https://api.comfy.org/v2/models/vertexai/gemini-3.1-flash-image?model_provider=wavespeed

strict_mode 默认为 false，因此 Router 会将本页记录的原始请求体转换为提供商自己的 schema，并将响应转换回来。请参阅 API 参考中的 model_provider、strict_mode 和 fallback_provider，以及服务提供商，了解所有以此方式路由的模型。

Schema

输入

contents object[] required

与模型当前对话的内容。对于单轮查询，这是一个单独实例。对于多轮查询，这是一个重复字段，包含对话历史和最新请求。

contents\[].parts object[] required

contents\[].parts\[].fileData object

基于 URI 的数据。

contents\[].parts\[].fileData.fileUri string

URI

contents\[].parts\[].fileData.mimeType 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/webm

contents\[].parts\[].inlineData object

以原始字节形式提供的内联数据。对于 gemini-2.0-flash-lite 和 gemini-2.0-flash，通过 inlineData 最多可以指定 3000 张图像。

contents\[].parts\[].inlineData.data string (byte)

要在提示中以内联方式包含的图像、PDF 或视频的 base64 编码。以内联方式包含媒体时，还必须指定数据的媒体类型（mimeType）。大小限制：20MB

格式：byte

contents\[].parts\[].inlineData.mimeType 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/webm

contents\[].parts\[].mediaProcessing string

模型如何读取此部分中的视频。设置 "AGENTIC" 可让模型自行决定检查哪些片段，而不是按固定帧率采样。省略则使用默认的固定帧率采样。在 gemini-3.7-flash 及更新的 Flash 模型上受支持。

contents\[].parts\[].text string

文本提示或代码片段。

contents\[].parts\[].thought boolean

表示此部分是模型的思考/推理步骤。

contents\[].role string

可选值：user, model

generationConfig object

生成的采样、长度和输出设置。每个字段都是可选的：下面声明了 default 的字段在省略时会应用该默认值，其余字段则回退到模型自身的行为。

generationConfig.imageConfig object

图像生成的配置

generationConfig.imageConfig.aspectRatio string

已生成图像的宽高比

generationConfig.imageConfig.imageOutputOptions object

可选。已生成图像的图像输出格式。

generationConfig.imageConfig.imageOutputOptions.compressionQuality integer

可选。输出图像的压缩质量。

generationConfig.imageConfig.imageOutputOptions.mimeType string

可选。在 Vertex AI 路径上（由 Comfy 自有凭据提供服务的请求，以及使用 GCP 服务账号进行身份验证的 BYOK 请求），输出应保存为的图像格式。这些路径接受的值为 image/png 和 image/jpeg，匹配时不区分大小写，并在转发请求之前规范化为小写；任何其他值都会被拒绝，并返回指明此字段的 400 错误。省略时默认为 image/png。使用 Google AI Studio API 密钥进行身份验证的 BYOK 请求是例外：该上游没有此属性，一旦出现该属性就会拒绝整个调用，因此该字段会从请求中删除，而不是被接受或拒绝，输出格式为 AI Studio 所选择的格式。在所有路径上，都应从返回的响应部分读回媒体类型（inlineData.mimeType，或者当设置了 uploadImagesToStorage 时使用 fileData.mimeType），而不是假定你发送的值。

generationConfig.imageConfig.imageSize string

可选。指定已生成图像的尺寸。支持的值为 1K、2K、4K。如果未指定，模型将使用默认值 1K。

generationConfig.maxOutputTokens integer

响应中可以生成的最大 token 数。一个 token 大约相当于 4 个字符。100 个 token 大致对应 60-80 个单词。

范围：16 到 65536

generationConfig.responseModalities \\TEXT, IMAGE[]

generationConfig.seed integer

当种子固定为特定值时，模型会尽力为重复请求提供相同的响应。但无法保证输出具有确定性。此外，即使使用相同的种子值，更改模型或参数设置（例如温度）也可能导致响应发生变化。默认情况下，会使用随机种子值。适用于以下模型：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

generationConfig.stopSequences string[]

generationConfig.temperature number (default: 1)

温度用于响应生成期间的采样，采样在应用 topP 和 topK 时进行。温度控制 token 选择过程中的随机程度。较低的温度适合那些要求回答不太开放或更具确定性的提示词，而较高的温度则可能带来更多样或更具创造性的结果。温度为 0 表示始终选择概率最高的 token。在这种情况下，给定提示词的响应大多是确定性的，但仍可能出现少量变化。如果模型返回的响应过于泛泛、过短，或者模型给出了兜底响应，请尝试提高温度。

范围：0 到 2

格式：float

generationConfig.thinkingConfig object

可选。思考功能的配置。思考是指模型将复杂任务分解为更小的步骤，从而生成更高质量响应的过程。

generationConfig.thinkingConfig.includeThoughts boolean

可选。如果为 true，模型会在响应中包含其思考内容。

generationConfig.thinkingConfig.thinkingBudget integer

可选。模型思考过程的 token 预算。模型会尽力控制在此预算范围内。

generationConfig.thinkingConfig.thinkingLevel string

可选。模型的思考级别。

可能的值：THINKING_LEVEL_UNSPECIFIED、LOW、MEDIUM、HIGH、MINIMAL

generationConfig.topK integer (default: 40)

Top-K 会改变模型为输出选择 token 的方式。top-K 为 1 表示下一个被选中的 token 是模型词表中所有 token 里概率最高的那个。top-K 为 3 表示通过温度从 3 个概率最高的 token 中选择下一个 token。

范围：1 到 …

generationConfig.topP number (default: 0.95)

如果指定了该值，则使用核采样。 Top-P 会改变模型为输出选择 token 的方式。token 从概率最高（参见 top-K）到最低依次选取，直到它们的概率之和等于 top-P 值。例如，如果 token A、B、C 的概率分别为 0.3、0.2 和 0.1，而 top-P 值为 0.5，那么模型会通过温度从 A 或 B 中选择下一个 token，并排除 C 作为候选。 指定较低的值可获得随机性更低的响应，指定较高的值可获得随机性更高的响应。

范围：0 到 1

格式：float

safetySettings object[]

用于阻止不安全内容的按请求设置。在 GenerateContentResponse.candidates 上强制执行。

safetySettings\[].category string required

可能的值：HARM_CATEGORY_SEXUALLY_EXPLICIT、HARM_CATEGORY_HATE_SPEECH、HARM_CATEGORY_HARASSMENT、HARM_CATEGORY_DANGEROUS_CONTENT

safetySettings\[].threshold string required

可能的值：OFF、BLOCK_NONE、BLOCK_LOW_AND_ABOVE、BLOCK_MEDIUM_AND_ABOVE、BLOCK_ONLY_HIGH

systemInstruction object

用于引导模型获得更佳表现的指令。例如，“尽可能简洁地回答”或“回答中不要使用技术术语”。这些文本字符串会计入 token 限制。systemInstruction 的 role 字段会被忽略，不影响模型的表现。注意：各部分中只应使用文本，且每个部分中的内容应放在单独的段落中。

systemInstruction.parts object[] required

构成单条消息的有序部分列表。不同的部分可以有不同的 IANA MIME 类型。有关输入的限制（例如最大 token 数或图像数量），请参阅 Google 模型页面上的模型规格说明。

systemInstruction.parts\[].text string

文本提示词或代码片段。

systemInstruction.role string

创建该消息的实体的身份。支持以下值：user：表示该消息由真实的人发送，通常是用户生成的消息。model：表示该消息由模型生成。在多轮对话中，使用 model 值可将来自模型的消息插入对话。对于非多轮对话，此字段可以留空或不设置。

可能的值：user、model

tools object[]

一段代码，使系统能够与外部系统交互，以执行模型知识和范围之外的操作或一组操作。参见函数调用。

tools\[].functionDeclarations object[]

tools\[].functionDeclarations\[].description string

tools\[].functionDeclarations\[].name string required

tools\[].functionDeclarations\[].parameters object

函数参数的 JSON schema

uploadImagesToStorage boolean

若为 true，已生成的图像将上传至云端存储，并以签名 URL 的形式返回，而不是内联的 base64 数据。这些 URL 在 24 小时后过期。

videoMetadata object

对于视频输入，表示视频起始和结束偏移量，采用 Duration 格式。例如，要指定从 1:00 开始的 10 秒片段，请设置 "startOffset": \{ "seconds": 60 } 和 "endOffset": \{ "seconds": 70 }。仅当视频数据以 inlineData 或 fileData 形式呈现时，才应指定该元数据。

videoMetadata.endOffset object

表示视频时间轴位置的时长偏移量。

videoMetadata.endOffset.nanos integer

以纳秒分辨率表示的带符号秒的小数部分。带小数的负秒值仍必须具有非负的 nanos 值。

范围：0 到 999999999

videoMetadata.endOffset.seconds integer

时间跨度的带符号秒数。必须在 -315,576,000,000 到 +315,576,000,000 之间（含边界）。

范围：-315576000000 到 315576000000

videoMetadata.startOffset object

表示视频时间轴位置的时长偏移量。

videoMetadata.startOffset.nanos integer

以纳秒分辨率表示的带符号秒的小数部分。带小数的负秒值仍必须具有非负的 nanos 值。

范围：0 到 999999999

videoMetadata.startOffset.seconds integer

时间跨度的带符号秒数。必须在 -315,576,000,000 到 +315,576,000,000 之间（含边界）。

范围：-315576000000 到 315576000000

由 Router 在 GET /v2/models/vertexai/gemini-3.1-flash-image/openapi.json 提供的 schema 生成，该文档与请求到达提供商之前用于校验调用的文档相同。

输出

candidates object[]

candidates\[].citationMetadata object

candidates\[].citationMetadata.citations object[]

candidates\[].citationMetadata.citations\[].authors string[]

candidates\[].citationMetadata.citations\[].endIndex integer

candidates\[].citationMetadata.citations\[].license string

candidates\[].citationMetadata.citations\[].publicationDate string (date)

格式：date

candidates\[].citationMetadata.citations\[].startIndex integer

candidates\[].citationMetadata.citations\[].title string

candidates\[].citationMetadata.citations\[].uri string

candidates\[].content object

当前与模型对话的内容。对于单轮查询，这是一个单独的实例。对于多轮查询，这是一个重复字段，包含对话历史和最新的请求。

candidates\[].content.parts object[] required

candidates\[].content.parts\[].fileData object

基于 URI 的数据。

candidates\[].content.parts\[].fileData.fileUri string

URI

candidates\[].content.parts\[].fileData.mimeType 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/webm

candidates\[].content.parts\[].inlineData object

原始字节形式的内联数据。对于 gemini-2.0-flash-lite 和 gemini-2.0-flash，最多可以使用 inlineData 指定 3000 张图像。

candidates\[].content.parts\[].inlineData.data string (byte)

要以内联方式包含在提示中的图像、PDF 或视频的 base64 编码。以内联方式包含媒体时，还必须指定该数据的媒体类型（mimeType）。大小限制：20MB

格式：byte

candidates\[].content.parts\[].inlineData.mimeType 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/webm

candidates\[].content.parts\[].mediaProcessing string

模型如何读取此部分中的视频。设置 "AGENTIC" 可让模型自行决定要检查哪些片段，而不是按固定帧率采样。省略则使用默认的固定帧率采样。gemini-3.7-flash 及更新的 Flash 模型支持此功能。

candidates\[].content.parts\[].text string

文本提示或代码片段。

candidates\[].content.parts\[].thought boolean

表示此部分是模型的思考/推理步骤。

candidates\[].content.role string

可能的值：user, model

candidates\[].finishReason string

candidates\[].safetyRatings object[]

candidates\[].safetyRatings\[].category string

可能的值：HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_HARASSMENT, HARM_CATEGORY_DANGEROUS_CONTENT

candidates\[].safetyRatings\[].probability string

内容违反指定安全类别的概率

可能的值：NEGLIGIBLE, LOW, MEDIUM, HIGH, UNKNOWN

createTime string

响应创建时的时间戳。

modelVersion string

用于生成响应的模型版本。

promptFeedback object

promptFeedback.blockReason string

promptFeedback.blockReasonMessage string

promptFeedback.safetyRatings object[]

promptFeedback.safetyRatings\[].category string

可选值：HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_HARASSMENT, HARM_CATEGORY_DANGEROUS_CONTENT

promptFeedback.safetyRatings\[].probability string

内容违反指定安全类别的概率

可选值：NEGLIGIBLE, LOW, MEDIUM, HIGH, UNKNOWN

responseId string

响应的唯一标识符。

usageMetadata object

usageMetadata.cachedContentTokenCount integer

仅输出。输入中缓存部分（缓存内容）的 token 数量。

usageMetadata.candidatesTokenCount integer

响应中的 token 数量。

usageMetadata.candidatesTokensDetails object[]

按模态划分的候选 token 明细。

usageMetadata.candidatesTokensDetails\[].modality string

输入或输出内容的模态类型。

可选值：MODALITY_UNSPECIFIED, TEXT, IMAGE, VIDEO, AUDIO, DOCUMENT

usageMetadata.candidatesTokensDetails\[].tokenCount integer

给定模态的 token 数量。

usageMetadata.promptTokenCount integer

请求中的 token 数量。设置 cachedContent 后，这仍然是有效提示的总大小，也就是说它包含缓存内容中的 token 数量。

usageMetadata.promptTokensDetails object[]

按模态划分的提示 token 明细。

usageMetadata.promptTokensDetails\[].modality string

输入或输出内容的模态类型。

可选值：MODALITY_UNSPECIFIED, TEXT, IMAGE, VIDEO, AUDIO, DOCUMENT

usageMetadata.promptTokensDetails\[].tokenCount integer

给定模态的 token 数量。

usageMetadata.thoughtsTokenCount integer

思维输出中存在的 token 数量。

usageMetadata.toolUsePromptTokenCount integer

工具使用提示中存在的 token 数量。

usageMetadata.toolUsePromptTokensDetails object[]

按模态划分的工具使用提示 token 明细。

usageMetadata.toolUsePromptTokensDetails\[].modality string

输入或输出内容的模态类型。

可选值：MODALITY_UNSPECIFIED, TEXT, IMAGE, VIDEO, AUDIO, DOCUMENT

usageMetadata.toolUsePromptTokensDetails\[].tokenCount integer

给定模态的 token 数量。

usageMetadata.totalTokenCount integer

token 总数（提示 + 候选）。

usageMetadata.trafficType string

请求使用的流量类型（例如 PROVISIONED\_THROUGHPUT）。

示例

输入

{
  "contents": [
    {
      "role": "user",
      "parts": [
        {
          "text": "a single red maple leaf on a plain white background, studio lighting"
        }
      ]
    }
  ],
  "generationConfig": {
    "responseModalities": [
      "IMAGE"
    ],
    "imageConfig": {
      "aspectRatio": "1:1"
    }
  }
}

输出

{
  "candidates": [
    {
      "content": {
        "role": "model",
        "parts": [
          {
            "inlineData": {
              "mimeType": "image/png",
              "data": "PGJhc2U2ND4="
            }
          }
        ]
      },
      "finishReason": "STOP"
    }
  ],
  "usageMetadata": {
    "promptTokenCount": 12,
    "candidatesTokenCount": 1290
  }
}

默认情况下，已生成的图像部分会在 inlineData.data 中包含 base64 字节，并在 inlineData.mimeType 中包含媒体类型。解码这些字节并将其保存到文件中。当设置 uploadImagesToStorage: true 时，上传的图像则改用 fileData.fileUri 提供签名 URL，并使用 fileData.mimeType 提供媒体类型。请在 URL 过期之前下载这些图像，它们会在创建 24 小时之后过期。上传失败会使该图像保持内联形式，因此请检查每个部分中是否包含 inlineData 或 fileData；文本部分也可能出现，并且图像不保证是第一个部分。上述快速入门示例中的 candidates[0].content.parts[0].inlineData.data 路径读取的是本页示例响应中唯一的内联部分；面对真实响应时，应扫描 parts 查找所需的键，而不是索引位置 0。

发布前须知

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