openai/gpt-5 的 API 参考文档,由 Comfy Router 从 OpenAI 提供。
输入: 文本, 图像 · 输出: 文本
快速开始
在你的 Comfy 工作区中创建一个密钥,并将其导出为COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK(pip install comfy-sdk 和 npm install @comfyorg/sdk);cURL 代码片段是通过原始 HTTP 发起的相同调用。
模型 ID: openai/gpt-5
端点: POST https://api.comfy.org/v2/models/openai/gpt-5
- 等待结果
- 排队并稍后收集
将相同的请求体发送到
POST https://api.comfy.org/v2/models/openai/gpt-5/requests。运行被受理后,Router 会立即返回 201 和 request_id;结果就绪后,可以从本进程或其他进程收集。队列投递 介绍了状态、取消与收集的细节。Schema
输入
为响应生成的 token 数量上限,包括可见输出 token 和推理 token。在推理类 id 上,该上限与隐藏的推理 token 共享,因此较小的值可能在产生任何可见文本之前就耗尽整个预算,这也是推理冒烟用例发送 1024 而聊天用例发送 16 的原因。范围:
1 至 …OpenAI 模型标识符。在 Comfy Router 上该字段是可选的,Router 会从
{model} 路径段填充它;显式的 null 也会以相同方式被替换。发送与路径不一致的值会被拒绝。声明该字段是为了让发送它的调用方不被拒绝,但在此接口上它是无作用的:Router 会在分发之前将其设置为
false,因为它捕获的是提供商响应,而不是转发 text/event-stream。Router 无法解码该流,因此流式生成会被 OpenAI 计费,却无人计量。没有任何 Comfy 接口提供流式服务:v1 的 POST /proxy/openai/v1/responses 入口会以 400 拒绝 stream: true,且绝不将请求转发到上游,因此在任一接口上都应省略该字段或发送 false,并将已完成的响应作为单个 JSON 主体读取。采样温度。仅限聊天层级:o 系列推理 id(
o1、o1-pro、o3、o4-mini)在 OpenAI 处会拒绝该参数。Router 不会替它们拒绝该参数(原因见本组件关于两个层级共用同一 schema 的说明),因此发送该参数的推理调用会由 OpenAI 自身的错误来回应。范围:0 至 2上下文超出模型窗口时的截断策略。此处枚举确实会被强制执行,与上述三种词汇表不同,因为这两个值是 OpenAI 文档记载的完整集合,且至今未增加。显式的
null 仍会被接受,条款与其上方的字段相同。可选值:auto、disabledGET /v2/models/openai/gpt-5/openapi.json 提供的 schema 生成,该文档与它在请求到达提供商之前用于校验调用的文档相同。
输出
将一条系统(或开发者)消息插入到模型上下文的第一个位置。与
previous_response_id 一起使用时,上一个响应的 instructions 不会延续到下一个响应。这样可以轻松地在新的响应中替换系统(或开发者)消息。一次响应可生成的 token 数量上限,包括可见输出 token 和推理 token。
用于模型响应的截断策略。
-
auto:如果本次响应及之前响应的上下文超过模型的上下文窗口大小,模型将通过丢弃对话中间的输入项来截断响应,使其适应上下文窗口。 -
disabled(默认):如果模型响应将超过模型的上下文窗口大小,请求会以 400 错误失败。 可选值:auto、disabled
上一个响应的唯一 ID。用它来创建多轮对话。了解更多关于
对话状态的内容。
仅限 o 系列模型推理模型的配置选项。
仅限 o 系列模型限制推理模型的推理力度。
目前支持的值为
low、medium 和 high。降低推理力度可以加快响应速度,并减少响应中用于推理的 token 数量。可选值:low、medium、high弃用: 请改用
summary。模型所执行推理的摘要。这对于调试和理解模型的推理过程很有用。
可取 auto、concise 或 detailed。可选值:auto、concise、detailed一个用于指定模型必须输出的格式的对象。配置
{ "type": "json_schema" } 会启用结构化输出,
从而确保模型符合你提供的 JSON schema。了解更多内容请参阅
结构化输出指南。默认格式为 { "type": "text" },不带任何额外选项。不推荐用于 gpt-4o 及更新的模型:设置为 { "type": "json_object" } 会启用较旧的 JSON 模式,
它能确保模型生成的消息是有效的 JSON。对于支持 json_schema 的模型,
建议优先使用它。该响应的错误代码。可选值:
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模型生成的内容项数组。
output数组中各项的长度和顺序取决于模型的响应。- 与其访问
output数组中的第一项并假定它是包含模型所生成 内容的assistant消息,不如考虑使用 SDK 中支持的output_text属性。
响应生成的状态。取值为
completed、failed、in_progress、cancelled、queued 或 incomplete 之一。可选值:completed、failed、in_progress、cancelled、queued、incomplete从缓存中检索到的 token 数量。
有关提示缓存(prompt caching)的更多信息。
示例
输入
输出
发布前须知
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 目前不支持的功能,以及替代方案。