跳到主要内容

基于给定输入从大语言模型生成响应。Responses API 提供了统一的接口，支持文本生成、多轮续接、工具调用、推理配置和可选的流式输出。

授权​

发起 REST API 请求时，必须在请求头中包含 AccessToken 以及 Content-Type 头。您可以使用以下格式进行授权：

--header 'Authorization: Bearer <your_token_here>'
--header 'Content-Type: application/json'

注意：请将 your_token_here 替换为您的实际 AccessToken。它包含允许服务器验证您的身份和权限的信息。 您可以在此处创建 API 密钥。

请求体​

字段类型必填描述
backgroundboolean, null否是否在后台运行模型响应。
includestring[]否要在响应中包含的附加输出数据数组，例如 file_search_call.results、message.output_text.logprobs、web_search_call.action.sources 或 reasoning.encrypted_content。
modelstring是用于生成响应的模型名称
inputstring, string[]是用于生成响应的输入，可以是单个字符串或字符串数组
instructionsstring否可选指令，用于指导模型的响应生成，提供特定的指示或输出约束。
streamboolean, null否是否在生成时以流式方式返回响应（默认：false）
max_output_tokensinteger, null否响应中生成的最大 Token 数
max_tool_callsinteger, null否响应生成期间允许的最大工具调用次数，有助于控制外部工具使用的程度。
temperaturenumber, null否生成响应时使用的采样温度
top_pnumber, null否生成响应时使用的核采样概率，有助于在生成的响应中平衡随机性和连贯性。
textobject否文本输出的配置选项，包括通过 text.format 的纯文本和结构化 JSON 输出。
parallel_tool_callsboolean, null否响应生成期间是否允许并行工具调用，支持同时调用多个工具以提高处理效率。
previous_response_idstring, null否用作上下文以生成新响应的先前响应 ID，允许基于先前交互进行续接对话或后续响应。
metadataobject否包含要包含在请求中的附加元数据的对象，可用于跟踪、日志记录或为响应生成提供额外上下文等用途。
reasoningobject否包含推理模型配置的对象，可用于在响应生成期间启用或自定义模型的推理能力。
storeboolean, null否是否将生成的响应存储在系统中以供将来参考或分析（默认：false）
tool_choicestring, null否响应生成期间模型需要在多个工具之间进行选择时使用的策略，例如 auto、none 或 required。
toolsarray, null否模型在响应生成期间可以调用的工具定义数组，允许增强功能和与外部系统集成。每个工具定义包括工具名称、描述、参数和其他相关信息，以指导模型有效使用工具。
truncationstring, null否模型响应使用的截断策略。支持值为 auto 和 disabled（默认）。

工具配置​

目前，API 仅支持函数工具。tools 数组中的每个对象应具有以下结构：

字段类型必填描述
typestring是工具类型。目前支持 function。
namestring是模型可以调用的函数名称。
descriptionstring, null否函数功能的描述，供模型决定何时及如何调用。
parametersobject是定义函数参数的 JSON Schema 对象。
strictboolean, null否模型调用函数时是否应严格遵循提供的参数 schema。

parameters 的 JSON Schema 示例：

{
  "type": "object",
  "properties": {
    "location": {
      "type": "string",
      "description": "The city and country, for example: Singapore, Singapore"
    }
  },
  "required": ["location"],
  "additionalProperties": false
}

推理配置​

字段类型必填描述
effortstring否支持推理的模型使用的推理努力级别，例如 minimal、low、medium 或 high。
summarystring, null否控制所选模型支持时是否生成推理摘要。

文本配置​

text 对象配置文本输出格式和详细程度。

字段类型必填描述
formatobject否响应格式。默认为 { "type": "text" }。使用 { "type": "json_schema" } 进行结构化输出，或 { "type": "json_object" } 进入 JSON 模式。
verbositystring, null否控制输出的详细程度。支持值为 low、medium 和 high。

format 对象应具有以下结构：

字段类型必填描述
typestring是格式类型。支持值为 text、json_object 和 json_schema。
namestring否JSON Schema 响应格式的名称。当 type 为 json_schema 时必填。
descriptionstring否响应格式的描述，供模型决定如何响应。
schemaobject否模型输出必须遵循的 JSON Schema 对象。当 type 为 json_schema 时必填。
strictboolean, null否生成结构化输出时是否启用严格的 schema 遵循。

Include 配置​

include 数组控制响应中返回的可选字段。常用值包括：

值描述
file_search_call.results包含文件搜索结果。
message.output_text.logprobs包含输出文本的对数概率。
web_search_call.action.sources包含网络搜索工具调用的来源。
reasoning.encrypted_content包含支持时的加密推理内容。

请求示例​

{
  "model": "minimax/minimax-m2.5",
  "input": "Explain the concept of a polymer in simple terms.",
  "instructions": "Answer clearly and concisely.",
  "stream": false,
  "max_output_tokens": 100,
  "temperature": 0.7,
  "top_p": 0.9,
  "text": {
    "format": {
      "type": "text"
    }
  },
  "parallel_tool_calls": true,
  "store": false,
  "truncation": "disabled"
}

响应​

成功响应​

字段类型描述
idstring响应的唯一标识符
objectstring返回的对象类型，此端点为 response
created_atinteger响应创建时的时间戳（自 Unix 纪元以来的秒数）
statusstring响应的状态，例如 completed、in_progress、failed 或 incomplete
completed_atinteger, null响应完成时的时间戳（自 Unix 纪元以来的秒数），如果可用。
modelstring用于生成响应的模型名称
outputarray模型生成的输出项数组，例如消息、推理项和工具调用。
output_textstringSDK 便利字段，包含可用时的聚合生成文本。不包含在原始 REST 响应体中。
errorobject, null如果响应失败，则为错误详情。
incomplete_detailsobject, null解释响应不完整原因的详情（如适用）。
instructionsstring, null此响应使用的指令。
max_output_tokensinteger, null为响应配置的最大输出 Token 数。
max_tool_callsinteger, null为响应配置的最大工具调用次数。
parallel_tool_callsboolean响应是否启用了并行工具调用。
previous_response_idstring, null用作上下文的先前响应 ID（如已提供）。
reasoningobject响应使用的推理配置。
storeboolean响应是否被存储。
temperaturenumber, null生成时使用的采样温度。
textobject生成时使用的文本配置。
tool_choicestring, object生成时使用的工具选择策略。
toolsarray模型可用的工具定义。
top_pnumber, null生成时使用的核采样概率。
truncationstring, null响应使用的截断策略。
usageobject请求和响应的 Token 使用量。
metadataobject与响应关联的附加元数据。