openai/gpt-6.1-terra 的 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-6.1-terra
端点: POST https://api.comfy.org/v2/models/openai/gpt-6.1-terra
- 等待结果
- 排队并稍后收取
同样的请求体,发送到
POST https://api.comfy.org/v2/models/openai/gpt-6.1-terra/requests。运行一旦被受理,Router 就会返回 201 和一个 request_id;结果就绪后即可收取,无论是在本进程还是其他进程中。队列投递详细介绍了状态、取消和收取的流程。Schema
输入
string[]
要在模型响应中包含的额外输出数据。
string | object[]
必填
发送给模型的文本、图像或文件输入,用于生成响应。这是此合约中 Router 无法提供的唯一字段,也是下方
required 中的唯一条目。string
将系统(或开发者)消息作为模型上下文的第一项插入。
integer
为响应生成的 token 数量的上限,包括可见输出 token 和推理 token。对于推理 id,此上限与隐藏的推理 token 共用,因此较小值可能在任何可见文本出现之前就耗尽整个预算;这就是推理冒烟测试用例发送 1024,而聊天用例发送 16 的原因。范围:
1 到 …string
OpenAI 模型标识符。在 Comfy Router 上,此字段为可选,Router 会从
{model} 路径段中填充它;显式传入的 null 也会以相同方式被替换。发送与路径不一致的值会被拒绝。boolean
是否允许模型并行运行工具调用。
string
上一个响应的 ID,用于多轮对话。
object
仅限 REASONING 层级。推理模型的配置,例如
{"effort": "medium"}。原样转发;有关可接受的键,请参阅 OpenAI 的推理指南。chat 层级的 id 会忽略它。boolean
OpenAI 是否存储已生成的响应以便稍后检索。
boolean
声明此字段,是为了让发送它的调用方不会被拒绝,但它在当前接口上不起作用:Router 会在分发前将其固定为
false,因为它捕获的是提供商响应,而不是转发 text/event-stream;Router 无法解码该流,所以流式生成会被 OpenAI 计费,却不会被任何人计量。没有任何 Comfy 接口会提供该流:v1 POST /proxy/openai/v1/responses 入口会以 400 拒绝 stream: true,并且绝不会将请求转发到上游,因此在任一接口上省略该字段或发送 false,然后将已完成的响应作为一个 JSON 主体读取。number
采样温度。仅限 CHAT 层级:在 OpenAI 上,o 系列推理 id(
o1、o1-pro、o3、o4-mini)会拒绝此参数。Router 不会替它们拒绝该参数(关于这两个层级为何共用同一 schema 的说明,请参阅此组件的注释),因此发送该参数的推理调用将由 OpenAI 自身的错误来回应。范围:0 到 2object
输出格式配置,例如用于结构化输出的
{"format": {"type": "json_schema", ...}}。原样转发。string | object
模型应如何选择要使用的工具。可以是字符串模式,也可以是指定工具的对象。
object[]
模型可以调用的工具定义。Router 不会缩小工具分类的范围;有关可接受的形状,请参阅 OpenAI 的 Responses API 参考。
number
核采样截止值。仅限 CHAT 层级,条件与
temperature 相同。范围:0 到 1string
当上下文超出模型窗口时的截断策略。与上面的三个词汇表不同,此处的枚举确实会被强制执行,因为这两个值是 OpenAI 记录的完整集合,且该集合没有增加。显式传入的
null 仍会被接受,条件与上方字段相同。可选值:auto、disabledobject
Token 用量封装。它出现在此合约中,是因为 v1 操作在请求体上声明了它;OpenAI 会在响应中填充它,因此调用方没有理由发送它。
GET /v2/models/openai/gpt-6.1-terra/openapi.json 提供的 schema 生成,该文档与 Router 在请求到达提供商之前用于验证调用的文档相同。
输出
string
将一条系统(或开发者)消息插入模型上下文的第一个位置。与
previous_response_id 一起使用时,上一个响应中的指令不会延续到下一个响应。这样可以轻松地在新的响应中替换系统(或开发者)消息。string
用于生成响应的模型
number
默认值:"1"
控制响应的随机性范围:
0 到 2number
默认值:"1"
通过核采样控制响应的多样性范围:
0 到 1string
默认值:"\"disabled\""
用于模型响应的截断策略。
-
auto:如果此响应及之前响应的上下文超出模型的上下文窗口大小,模型将通过丢弃对话中间的输入项来截断响应,以适应上下文窗口。 -
disabled(默认):如果模型响应将超出模型的上下文窗口大小,请求将失败并返回 400 错误。 可选值:auto、disabled
string
控制后续轮次中哪些推理项会回传给模型,例如
auto、current_turn 或 all_turns。string
默认值:"\"medium\""
仅限 o 系列模型限制推理模型的推理力度。当前支持的值为
low、medium 和 high。降低推理力度可以带来更快的响应,并减少响应中用于推理的 token 数量。可选值:low、medium、highstring
已弃用: 请改用
summary。模型所执行推理的摘要。这对于调试和理解模型的推理过程很有用。取值为 auto、concise 或 detailed 之一。可选值:auto、concise、detailedstring
用于响应的推理模式。
string
模型所执行推理的摘要。这对于调试和理解模型的推理过程很有用。取值为
auto、concise 或 detailed 之一。可选值:auto、concise、detailedobject
object
一个对象,用于指定模型必须输出的格式。配置
{ "type": "json_schema" } 会启用结构化输出,确保模型与提供的 JSON schema 匹配。在结构化输出指南中了解更多。默认格式为 { "type": "text" },不附加其他选项。不推荐用于 gpt-4o 及更新模型:设置为 { "type": "json_object" } 会启用较旧的 JSON 模式,确保模型生成的消息是有效的 JSON。对于支持 json_schema 的模型,推荐使用它。string
约束模型响应的详细程度。取值为
low、medium 或 high 之一。`none`, `auto`, `required` | object
模型在生成响应时应如何选择使用哪个(或哪些)工具。请参阅
tools 参数,了解如何指定模型可以调用的工具。object[]
boolean
模型响应是否在后台运行。
object
响应的计费信息。
string
负责支付响应费用的一方。
number
此响应完成时的 Unix 时间戳(以秒为单位)。仅在状态为
completed 时存在。number
此响应创建时的 Unix 时间戳(以秒为单位)。
object
模型生成响应失败时返回的错误对象。
string
必填
响应的错误代码。可选值:
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_foundstring
必填
错误的可读描述。
number
根据新 token 在目前为止文本中已有的出现频率对其进行惩罚。
string
此响应的唯一标识符。
object
关于响应为何不完整的详情。
string
响应不完整的原因。可选值:
max_output_tokens、content_filterinteger
单个响应中可处理的内置工具调用总次数的上限。
object
可附加到响应上的键值对集合。
object
响应输入和输出的审核结果(如果请求了经过审核的补全)。
string
此资源的对象类型,始终设置为
response。可选值:responseobject[]
由模型生成的内容项数组。
output数组中各项的长度和顺序取决于模型的响应。- 与其访问
output数组中的第一项并假定它是包含模型生成内容的assistant消息,不如在 SDK 支持的情况下考虑使用output_text属性。
string
仅 SDK 提供的便捷属性,包含
output 数组中所有 output_text 项聚合后的文本输出(如果存在)。
在 Python 和 JavaScript SDK 中受支持。boolean
默认值:"true"
是否允许模型并行执行工具调用。
number
根据新 token 是否已出现在目前为止的文本中对其进行惩罚。
string
由 OpenAI 用于缓存相似请求的响应,以优化缓存命中率。替代
user 字段。string
提示缓存的保留策略,例如
in_memory 或 24h。string
用于帮助检测可能违反 OpenAI 使用政策的应用程序用户的稳定标识符。
string
用于处理请求的处理层级,例如
auto、default、flex、scale 或 priority。string
响应生成的状态。取值为
completed、failed、in_progress、cancelled、queued 或 incomplete。可选值:completed、failed、in_progress、cancelled、queued、incompleteboolean
是否存储响应以便之后通过 API 检索。
object
按内置工具细分的 token 和请求用量。
object
图像生成工具的 token 用量。
integer
object
integer
integer
integer
object
integer
integer
integer
object
搜索工具用量。
integer
integer
在每个 token 位置返回的最可能 token 的最大数量,每个都带有相应的对数概率。
object
表示 token 用量详情,包括输入 token 数、输出 token 数、
输出 token 的细分以及所使用的 token 总数。
integer
必填
输入 token 的数量。
object
必填
输入 token 的详细细分。
integer
写入缓存的输入 token 数量。
object
按缓存生命周期拆分的缓存写入量。两项计数之和等于
cache_write_tokens。integer
写入缓存且生命周期为 12 小时的输入 token 数量。
integer
写入缓存且生命周期为 30 分钟的输入 token 数量。
integer
必填
从缓存中取回的 token 数量。
关于提示词缓存的更多说明。
integer
必填
输出 token 的数量。
object
必填
输出 token 的详细明细。
integer
必填
推理 token 的数量。
integer
必填
使用的 token 总数。
string
已弃用的最终用户标识符。已由
safety_identifier 和 prompt_cache_key 替换。示例
输入
输出
发布前须知
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 目前不支持的功能,以及替代方案。