跳到主要内容

Responses API

POST 
/responses

以 OpenAI Responses API 格式创建模型响应。

该 API 是无状态的：服务端不存储响应与会话。多轮对话需要客户端在每次请求的 input 中回传完整对话历史。详细说明（含完整的参数兼容性表）请参考 Responses API 指南。

Request​

Body

required

    model stringrequired

    Possible values: [deepseek-flash, deepseek-v4-pro]

    使用的模型的 ID。请使用 deepseek-flash 或 deepseek-v4-pro。

    input string | object[]

    nullable

    模型的输入。既可以传纯字符串（视作一条 user 消息），也可以传输入 item 列表。

    支持的输入 item 类型为 message / function_call / function_call_output / custom_tool_call / custom_tool_call_output / reasoning，其他类型会被忽略。消息角色支持 user / assistant / system / developer（developer 视同 user）。使用 deepseek-flash 模型时，user / developer 消息 item 以及 function_call_output / custom_tool_call_output item 的 output 中支持 input_image 内容块；system / assistant 消息中的图片将返回 400 错误。文件输入不支持。

    input 与 instructions 至少传一个。

    oneOf

    string

    instructions stringnullable

    系统级指令，作为模型上下文中的第一条 system 消息。

    reasoning

    object

    nullable

    思考模式配置。

    effort string

    Possible values: [none, low, high, max]

    控制思考模式开关与思考强度。none 关闭思考模式；low / high / max 开启思考模式。不传时使用模型默认的思考行为（默认开启）。出于兼容考虑，minimal 映射为 low，medium / xhigh 映射为 high。

    max_output_tokens integernullable

    响应可生成的 token 数上限，包含可见的输出 token 与思维链 token。

    stream booleannullable

    如果设置为 true，响应将以语义化的流式 SSE 事件返回。最后一个事件是 response.completed / response.incomplete / response.failed（没有 data: [DONE] 消息）。完整事件列表请参考 Responses API 指南。

    temperature numbernullable

    Possible values: <= 2

    Default value: 1

    采样温度，介于 0 和 2 之间。更高的值（如 0.8）会使输出更随机，而更低的值（如 0.2）会使其更加集中和确定。思考模式下不生效。

    top_p numbernullable

    Possible values: <= 1

    Default value: 1

    用于调节输出的随机性，可替代 temperature。该参数仅在思考模式下生效，有效取值范围为 0.95–1.0，低于 0.95 的取值会按 0.95 处理；在非思考模式下恒为 1.0，传入的值会被忽略。

    text

    object

    nullable

    文本输出配置。

    format

    object

    输出格式。{"type": "text"}（默认）为纯文本输出；{"type": "json_object"} 为 JSON 模式；{"type": "json_schema", "name": ..., "schema": ...} 为结构化输出，输出符合给定的 JSON Schema。

    type string

    Possible values: [text, json_object, json_schema]

    Default value: text

    name string

    schema 的名称。type 为 json_schema 时必填。

    schema object

    输出必须符合的 JSON Schema。type 为 json_schema 时必填。

    tools

    object[]

    nullable

    模型可能会调用的工具的列表。函数名必须非空、不超过 128 个字符、匹配 ^[a-zA-Z0-9_-]+$，且所有工具的名称必须唯一。内置工具类型会被忽略。详情请参考 Responses API 指南。

  • Array [

    • type stringrequired

    Possible values: [function]

    工具的类型。

    name string

    用于 function 工具。函数的名称。必须非空、不超过 128 个字符、匹配 ^[a-zA-Z0-9_-]+$，且所有工具的名称必须唯一。

    description string

    用于 function 工具。函数功能的描述，供模型理解何时以及如何调用该函数。

    parameters

    object

    function 的输入参数，以 JSON Schema 对象描述。请参阅Tool Calls 指南获取示例，并参阅JSON Schema 参考了解有关格式的文档。省略 parameters 会定义一个参数列表为空的 function。

    property name* any

    function 的输入参数，以 JSON Schema 对象描述。请参阅Tool Calls 指南获取示例，并参阅JSON Schema 参考了解有关格式的文档。省略 parameters 会定义一个参数列表为空的 function。

  • ]

    • tool_choice string | object

    nullable

    控制模型调用工具的行为。

    none 意味着模型不会调用任何工具，而是生成一条消息。

    auto（默认）意味着模型可以选择生成一条消息或调用一个或多个工具。

    required 意味着模型必须调用一个或多个工具。

    通过 {"type": "function", "name": "my_function"} 指定特定工具，会强制模型调用该工具。

    oneOf

    string

    Possible values: [none, auto, required]

    top_logprobs integernullable

    Possible values: <= 20

    一个介于 0 到 20 之间的整数 N，指定每个输出位置返回输出概率 top N 的 token，且返回这些 token 的对数概率。

    user stringnullable

    自定义终端用户标识，字符集为 [a-zA-Z0-9\-_]，最大长度为 512。请勿在其中包含用户隐私信息。

    • 可用于区分您业务侧的用户身份，以帮助我们进行内容安全审核；也可用于 KVCache 隔离与调度隔离。详情请参考限速与用户隔离

Responses​

OK, 返回一个 response 对象。

Schema

    id stringrequired

    该响应的唯一标识符。

    object stringrequired

    Possible values: [response]

    object 的类型，其值恒为 response。

    created_at integerrequired

    标志响应创建时间的 Unix 时间戳（以秒为单位）。

    status stringrequired

    Possible values: [in_progress, completed, incomplete, failed]

    响应的状态。

    error objectnullable

    响应失败时的错误对象，包含 code 和 message 字段。

    incomplete_details

    object

    nullable

    响应不完整的原因详情。reason 字段可能为 max_output_tokens 或 content_filter。

    reason string

    Possible values: [max_output_tokens, content_filter]

    model stringrequired

    生成该响应的模型。

    output

    object[]

    required

    模型生成的输出 item 列表。思考模式下，思维链以 reasoning item 的形式在 message item 之前返回。函数调用以 function_call item 返回。

  • Array [

    • type string

    Possible values: [message, reasoning, function_call]

    输出 item 的类型。

    id string

    输出 item 的唯一 ID。

    status string

    Possible values: [in_progress, completed, incomplete]

    输出 item 的状态。

    role string

    Possible values: [assistant]

    用于 message item。其值恒为 assistant。

    content

    object[]

    用于 message item 时为 output_text 内容块列表。用于 reasoning item 时为 reasoning_text 内容块列表，以明文承载思维链内容。

  • Array [

    • type string

    Possible values: [output_text, reasoning_text]

    text string

  • ]

    • call_id string

    用于 function_call item。将函数调用结果回传给 API 时使用的标识符。

    name string

    用于 function_call item。要调用的函数的名称。

    arguments string

    用于 function_call item。模型生成的调用函数的入参，格式为 JSON。请注意，模型并不总是生成有效的 JSON，且可能会虚构出您的函数模式中未定义的参数。在调用函数之前，请在您的代码中验证这些入参是否有效。

  • ]

    • usage

    object

    该响应的 token 用量统计信息。

    input_tokens integerrequired

    输入 token 数。

    input_tokens_details

    object

    输入 token 的细分信息。

    cached_tokens integer

    命中上下文缓存的输入 token 数。参考上下文硬盘缓存。

    output_tokens integerrequired

    输出 token 数。

    output_tokens_details

    object

    输出 token 的细分信息。

    reasoning_tokens integer

    模型生成的思维链 token 数。

    total_tokens integerrequired

    该请求使用的 token 总数（输入 + 输出）。

Loading...