> ## Documentation Index > Fetch the complete documentation index at: https://docs.comfy.org/llms.txt > Use this file to discover all available pages before exploring further. # 将 GPT 5.6 Terra 与 Comfy Router 配合使用 > 通过 Comfy Router 调用 openai/gpt-5.6-terra：端点、请求形状以及 Router 返回的响应。 `openai/gpt-5.6-terra` 的 API 参考，由 Comfy Router 从 OpenAI 提供。 ## 快速开始在 [你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys) 中创建一个密钥，并将其导出为 `COMFY_API_KEY`。Python 和 TypeScript 代码片段使用 Comfy SDK(`pip install comfy-sdk`、`npm install @comfyorg/sdk`)；cURL 代码片段是通过原始 HTTP 发起的同一调用。 **模型 ID:** `openai/gpt-5.6-terra` **端点:** `POST https://api.comfy.org/v2/models/openai/gpt-5.6-terra` ```python Python theme={null} from comfy_sdk import Comfy # Reads COMFY_API_KEY from the environment. # The SDK automatically creates an idempotency key and reuses it for automatic retries. with Comfy() as client: result = client.models.run( "openai/gpt-5.6-terra", { "input": "Reply with the single word: ok", "max_output_tokens": 1024, }, ) print(result) ``` ```typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // Reads COMFY_API_KEY from the environment. // The SDK automatically creates an idempotency key and reuses it for automatic retries. const { data } = await comfy.models.run("openai/gpt-5.6-terra", { input: "Reply with the single word: ok", max_output_tokens: 1024, }); console.log(data); ``` ```bash cURL theme={null} curl https://api.comfy.org/v2/models/openai/gpt-5.6-terra \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" ``` 将相同的请求体发送到 `POST https://api.comfy.org/v2/models/openai/gpt-5-6-terra/requests`。运行被受理后，Router 会立即返回 `201` 和 `request_id`；结果就绪后，可以从本进程或其他进程收集。状态、取消与收集的细节见 [Queued delivery](/zh/development/comfy-router/queue)。 ```python Python theme={null} from comfy_sdk import Comfy # Reads COMFY_API_KEY from the environment. # Each submit() call mints its own Idempotency-Key and reuses it for automatic retries. with Comfy() as client: handle = client.models.submit( "openai/gpt-5.6-terra", { "input": "Reply with the single word: ok", "max_output_tokens": 1024, }, ) print("request_id:", handle.request_id) # with the model ID, all another process needs # Poll until the request completes, waiting the Retry-After the server names. for update in handle.iter_events(): print(update.status, update.queue_position) # The provider's own payload, the same value models.run() returns. # A request that failed or was cancelled raises the typed Router error here. result = handle.get() print(result) ``` ```typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // Reads COMFY_API_KEY from the environment. // Each submit() call mints its own Idempotency-Key and reuses it for automatic retries. const handle = await comfy.models.submit("openai/gpt-5.6-terra", { input: "Reply with the single word: ok", max_output_tokens: 1024, }); console.log("requestId:", handle.requestId); // with the model ID, all another process needs // Poll until the request completes, waiting the Retry-After the server names. for await (const update of handle.events()) { console.log(update.status, update.queuePosition); } // The same result models.run() returns. A request that failed or was cancelled rejects here. const result = await handle.get(); console.log(result.data); ``` ```bash cURL theme={null} # 1. Submit. Router answers 201 with request_id, status_url, response_url and cancel_url. curl https://api.comfy.org/v2/models/openai/gpt-5.6-terra/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" # 2. Poll until status is COMPLETED, waiting the Retry-After seconds each response names. REQUEST_ID="" curl -i https://api.comfy.org/v2/models/openai/gpt-5.6-terra/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" # 3. Collect. 200 with the model's native output, 202 with the status body while it is still running. curl https://api.comfy.org/v2/models/openai/gpt-5.6-terra/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY" ``` ## Schema ### 输入要在模型响应中包含的额外输出数据。传给模型的文本、图像或文件输入，用于生成响应。这是本契约中 Router 无法代为提供的唯一字段，也是下方 `required` 中的唯一条目。在模型上下文中插入一条系统（或开发者）消息，作为其中的第一项。单个响应可生成的 token 数量上限，包括可见的输出 token 和推理 token。在 reasoning 类 id 上，这一上限与隐藏的推理 token 共享，因此较小的值可能在产生任何可见文本之前就耗尽整个预算，这也是 reasoning 冒烟用例发送 1024、而 chat 用例只发送 16 的原因。范围：`1` 到 `…` OpenAI 模型标识符。在 Comfy Router 上该字段为可选，Router 会从 `{model}` 路径段为其填值；显式的 `null` 也以同样方式被替换。发送与路径不一致的值会被拒绝。是否允许模型并行执行工具调用。上一个响应的 ID，用于多轮对话。仅适用于 REASONING 层级。推理模型的配置，例如 `{"effort": "medium"}`。该字段原样转发；可接受的键请参见 OpenAI 的推理指南。chat 层级的 id 会忽略它。 OpenAI 是否存储生成的响应以便后续检索。声明该字段是为了让发送它的调用方不被拒绝，但它在此接口上是无效的：Router 会在派发之前将其置为 `false`，因为它捕获的是提供商响应，而不是转发 `text/event-stream`。openAiResponsesProxy 的 ModifyResponse 无法解码后者，因此流式生成会被 OpenAI 计费，却无人计量。如果需要流式输出，请使用 `POST /proxy/openai/v1/responses`。采样温度。仅限 CHAT 层级：o 系列 reasoning id（`o1`、`o1-pro`、`o3`、`o4-mini`）在 OpenAI 侧会拒绝该参数。Router 不会替它们拒绝，原因见本组件关于两个层级为何共用一套 schema 的说明，因此发送该参数的 reasoning 调用会由 OpenAI 自身的错误来回应。范围：`0` 到 `2` 输出格式配置，例如用于 Structured Outputs 的 `{"format": {"type": "json_schema", ...}}`。该字段原样转发。模型应如何选择使用哪个工具。可以是一个字符串模式，也可以是一个命名某个工具的对象。模型可调用的工具定义。Router 不会收窄工具分类；可接受的形状请参见 OpenAI 的 Responses API 参考。核采样截断值。仅限 CHAT 层级，适用与 `temperature` 相同的条件。范围：`0` 到 `1` 上下文超出模型窗口时的截断策略。与上面三组词表不同，这里的枚举确实会被强制执行，因为这两个值就是 OpenAI 文档中的完整集合，并且一直没有增长。显式 `null` 仍会被接受，条件与上面的字段相同。可能的值：`auto`、`disabled` token 用量封装。本契约之所以包含它，是因为 v1 操作在请求体上声明了它；OpenAI 会在响应中填充它，因此调用方没有理由发送它。本文档由 Router 在 `GET /v2/models/openai/gpt-5.6-terra/openapi.json` 提供的 schema 生成，也是在请求到达提供商之前用于校验调用的同一份文档。 ### 输出将系统（或开发者）消息作为模型上下文中的第一项插入。与 `previous_response_id` 一起使用时，上一个响应中的 instructions 不会延续到下一个响应。这使得在新响应中替换系统（或开发者）消息变得非常简单。响应可生成的 token 数量上限，包括可见的输出 token 和[推理 token](https://platform.openai.com/docs/guides/reasoning)。用于生成响应的模型控制响应中的随机性范围：`0` 至 `2` 通过 nucleus sampling 控制响应的多样性范围：`0` 至 `1` 用于模型响应的截断策略。 * `auto`：如果此响应以及之前响应的上下文超过模型的上下文窗口大小，模型将通过丢弃对话中间的输入项来截断响应，以适应上下文窗口。 * `disabled`（默认）：如果模型响应将超过模型的上下文窗口大小，请求将失败并返回 400 错误。可能的值：`auto`、`disabled` 上一个模型响应的唯一 ID。使用它来创建多轮对话。了解更多关于[对话状态](https://platform.openai.com/docs/guides/conversation-state)的信息。 **仅限 o 系列模型** [推理模型](https://platform.openai.com/docs/guides/reasoning)的配置选项。控制在后续轮次中将哪些推理项传回模型，例如 `auto`、`current_turn` 或 `all_turns`。 **仅限 o 系列模型** 约束[推理模型](https://platform.openai.com/docs/guides/reasoning)的推理力度。当前支持的值有 `low`、`medium` 和 `high`。降低推理力度可以带来更快的响应，并减少响应中用于推理的 token 数量。可能的值：`low`、`medium`、`high` \*\*弃用：\*\*请改用 `summary`。模型执行的推理摘要。这对于调试和理解模型的推理过程很有用。取值为 `auto`、`concise` 或 `detailed` 之一。可能的值：`auto`、`concise`、`detailed` 用于响应的推理模式。模型执行的推理摘要。这对于调试和理解模型的推理过程很有用。取值为 `auto`、`concise` 或 `detailed` 之一。可能的值：`auto`、`concise`、`detailed` 一个对象，用于指定模型必须输出的格式。配置 `{ "type": "json_schema" }` 可启用结构化输出，从而确保模型匹配你提供的 JSON schema。在[结构化输出指南](https://platform.openai.com/docs/guides/structured-outputs)中了解更多。默认格式为 `{ "type": "text" }`，不带其他选项。 **不建议用于 gpt-4o 及更新的模型：** 设置为 `{ "type": "json_object" }` 可启用较旧的 JSON 模式，确保模型生成的消息是有效的 JSON。对于支持 `json_schema` 的模型，优先使用它。约束模型响应的详细程度。取值为 `low`、`medium` 或 `high` 之一。模型在生成响应时应如何选择要使用的工具。查看 `tools` 参数以了解如何指定模型可以调用的工具。模型响应是否在后台运行。响应的计费信息。负责为该响应付费的主体。此响应完成时的 Unix 时间戳（以秒为单位）。仅当状态为 `completed` 时存在。此响应创建时的 Unix 时间戳（以秒为单位）。模型未能生成响应时返回的错误对象。该响应的错误代码。可能的值：`server_error`、`rate_limit_exceeded`、`invalid_prompt`、`vector_store_timeout`、`invalid_image`、`invalid_image_format`、`invalid_base64_image`、`invalid_image_url`、`image_too_large`、`image_too_small`、`image_parse_error`、`image_content_policy_violation`、`invalid_image_mode`、`image_file_too_large`、`unsupported_image_media_type`、`empty_image_file`、`failed_to_download_image`、`image_file_not_found` 错误的人类可读描述。根据新 token 在迄今文本中已有的出现频率对其进行惩罚。此 Response 的唯一标识符。关于响应为何不完整的详情。响应不完整的原因。可能的值：`max_output_tokens`、`content_filter` 一次响应中可以处理的、对内置工具的总调用次数上限。可附加到响应上的键值对集合。响应输入和输出的审核结果（如果请求了审核补全）。此资源的对象类型，始终设置为 `response`。可能的值：`response` 模型生成的内容项数组。 * `output` 数组中项的长度和顺序取决于模型的响应。 * 与其访问 `output` 数组中的第一项并假设它是包含模型所生成内容的 `assistant` 消息，不如考虑使用 SDK 中支持的 `output_text` 属性。仅 SDK 提供的便捷属性，包含 `output` 数组中所有 `output_text` 项聚合后的文本输出（如果存在）。在 Python 和 JavaScript SDK 中受支持。是否允许模型并行运行工具调用。根据新 token 是否出现在迄今文本中对其进行惩罚。 OpenAI 用于缓存相似请求的响应，以优化缓存命中率。取代 `user` 字段。提示缓存的保留策略，例如 `in_memory` 或 `24h`。一个稳定的标识符，用于帮助检测可能违反 OpenAI 使用政策的应用程序用户。用于处理该请求的处理层级，例如 `auto`、`default`、`flex`、`scale` 或 `priority`。响应生成的状态。为 `completed`、`failed`、`in_progress`、`cancelled`、`queued` 或 `incomplete` 之一。可能的值：`completed`、`failed`、`in_progress`、`cancelled`、`queued`、`incomplete` 是否存储该响应以便之后通过 API 检索。按内置工具细分的 token 和请求用量。图像生成工具的 token 用量。搜索工具的用量。在每个 token 位置返回的最可能 token 的最大数量，每个都带有对应的对数概率。表示 token 用量详情，包括输入 token、输出 token、输出 token 的细分以及所用的总 token 数。输入 token 的数量。输入 token 的详细细分。写入缓存的输入 token 数量。从缓存中检索到的 token 数量。 [详细了解提示缓存](https://platform.openai.com/docs/guides/prompt-caching)。输出 token 的数量。输出 token 的详细明细。推理 token 的数量。使用的 token 总数。已弃用的最终用户标识符。已替换为 `safety_identifier` 和 `prompt_cache_key`。 ## 示例 ### 输入 ```json theme={null} { "input": "Reply with the single word: ok", "max_output_tokens": 1024 } ``` ### 输出 ```json theme={null} { "completed_at": 1767225601, "created_at": 1767225600, "id": "resp_0a1b2c3d4e5f6a7b8c9d0e1f", "object": "response", "output": [ { "content": [ { "annotations": [], "text": "ok", "type": "output_text" } ], "id": "msg_0a1b2c3d4e5f6a7b8c9d0e1f", "role": "assistant", "status": "completed", "type": "message" } ], "output_text": "ok", "status": "completed", "usage": { "input_tokens": 14, "input_tokens_details": { "cached_tokens": 0 }, "output_tokens": 2, "output_tokens_details": { "reasoning_tokens": 0 }, "total_tokens": 16 } } ``` ## 发布前须知 SDK 会生成 `Idempotency-Key` 并在自动重试中复用它。手动重试时，请复用原始 key。Router 最长可保持连接 10 分钟。请求失败时，Router 会发送 `X-Comfy-Error-Type` 响应头说明原因。`422` 表示 Router 在调用提供商之前就拒绝了输入。生成的资源请及时下载，因为[结果链接会过期](/zh/development/comfy-router/reference#结果资产)。身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。模型发现、校验错误、重试与计费。 Router 目前不支持的功能，以及替代方案。