跳转到主要内容
调用 Chat Completions API,获取模型生成的对话响应数据。

请求地址

POST https://api.stepfun.com/v1/chat/completions
Step Plan 场景请使用 POST https://api.stepfun.com/step_plan/v1/chat/completions

请求参数

  • model string required
    需要使用的模型名称,例如 step-3.7-flashstepaudio-2.5-chatstep-3.5-flashstep-3.5-flash-2603step-router-v1 仅可通过 Step Plan 通道调用,详见本文「Step Plan 通道:DeepSeek 引擎字段差异」。
  • messages object array required
    迄今为止用户输入或模型生成的不同类别消息列表
  • tools object array optional
    Toolcall 支持的函数列表
  • audio object optional
    用于控制音频输出的参数,只在支持端到端模型场景的模型下生效(step-1o-audio/step-audio-2/step-audio-2-mini/step-audio-r1.1
  • modalities string array optional
    指定输出的模态类型,支持 textaudio 两种模态类型,只在端到端模型场景下必填。如果需要模型输出音频,则需要将 audio 添加到该参数中,建议设置为 ["text", "audio"]stepaudio-2.5-chat 仅支持 text,若选择 audio 会报错。
  • max_tokens int optional
    聊天需要生成的 标记 最大数量,默认值为 INF(不作限制,由模型自动决定)。输入 标记 和生成 标记 的总数量受限于指定模型的最大上下文长度。
  • temperature float optional
    采样温度,介于0.0和2.0之间的数字。较高值(如0.8)会使生成更随机,较低值(如0.2)会使其生成结果更集中且确定。默认值为0.5
  • top_p float optional
    核心采样,该值会使模型生成具有 top_p 概率质量的 标记 并输出到结果。默认值为0.9
  • n int optional
    控制模型为每个输入消息生成的响应消息结果条数,默认值为1,最大不限,建议不超过5。
  • stream bool optional
    是否流式生成响应消息,默认值为 false
  • stop string | string array optional
    用于指导模型生成聊天响应过程中,是否遇到 stop 中的内容,进行生成中断,默认为空
  • frequency_penalty float optional
    默认为0。介于0.0和1.0之间的数字。值较高会使模型生成某 token 时,根据其过往在生成文本中出现的频度,进行后续降频惩罚,从而降低模型重复生成相同内容的可能性
  • response_format object optional
    用于指导模型输出特定格式的内容。默认为 {"type":"text"},表示输出文本。
  • reasoning_format string optional
    用于指导模型输出时使用的 reasoning 字段;默认为 general,表示通用推理,使用 reasoning 字段返回结果;可选项为 [general,deepseek-style]。当设置为 deepseek-style 时,可使用 DeepSeek 兼容的 reasoning_content 字段获取到 reasoning 内容。
  • reasoning_effort string optional
    控制模型的推理深度。支持三档推理强度的模型可选值为 lowmediumhighstep-3.5-flash-2603 兼容 lowhigh 两档。值越高,模型会进行更深入的思考,但响应时间可能更长。

Step Plan 通道:DeepSeek 引擎字段差异

step-router-v1 仅可通过 Step Plan 通道(https://api.stepfun.com/step_plan/v1)调用,系统会自动在 deepseek-v4-prostep-3.5-flash 之间路由。该模型的字段约束与本文「请求参数」一致,下表列出的字段除外。
字段Step Plan 通道下的行为
model仅接受 step-router-v1,其他名称返回 HTTP 400 request_params_invalid
max_tokens上限为 384K
messages 中的图像 / 文档输入不支持,使用会返回 unsupported_content_type
tools 中的 web_search不支持,使用会返回 unsupported_content_type

响应格式

非流式响应

stream=false(默认)时,返回单个 Chat Completion 响应对象。

属性

  • id string
    生成的聊天响应 ID
  • object string
    模型生成聊天响应的模式,此模式下总为 chat.completion
  • model string
    模型名称
  • created timestamp
    生成聊天响应时的 Unix 时间戳,单位为秒
  • choices object array
    模型生成的聊天响应结果的可选路径列表。
  • usage object
    模型聊天响应生成的 标记 统计信息

示例

{
  "id": "b7b56af0-52a6-483f-a589-948182676a1b",
  "object": "chat.completion",
  "created": 1709893411,
  "model": "step-3.7-flash",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "你好!阶跃星辰是一家专注于人工智能技术的公司,致力于开发和提供各种AI解决方案。我们的人工智能技术涵盖了自然语言处理、计算机视觉、机器学习等领域,旨在帮助用户在各个行业和领域中提高效率和创造价值。"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": { "prompt_tokens": 83, "completion_tokens": 176, "total_tokens": 259 }
}

流式响应

stream=true 时,返回 Server-Sent Events (SSE) 格式的流式数据。每个事件包含一个 Chat Completion 响应对象块。

属性

  • id string
    生成的聊天响应 ID
  • object string
    模型生成聊天响应的模式,此模式下总为 chat.completion.chunk
  • created timestamp
    聊天响应时的 Unix 时间戳,单位为秒
  • model string
    模型名称
  • choices object array
    模型流式生成的聊天响应结果的可选路径列表。单个 choice object 属性:
  • usage object
    模型聊天响应生成的 标记 统计信息

示例

data: {"id":"d7ae7c4a-1524-4fe5-9d58-e4d59b89d8f0","object":"chat.completion.chunk","created":1709899323,"model":"step-3.7-flash","choices":[{"index":0,"delta":{"role":"","content":"您"},"finish_reason":""}],"usage":{"prompt_tokens":83,"completion_tokens":1,"total_tokens":84}}

data: {"id":"d7ae7c4a-1524-4fe5-9d58-e4d59b89d8f0","object":"chat.completion.chunk","created":1709899323,"model":"step-3.7-flash","choices":[{"index":0,"delta":{"role":"","content":"好"},"finish_reason":""}],"usage":{"prompt_tokens":83,"completion_tokens":2,"total_tokens":85}}

data: {"id":"d7ae7c4a-1524-4fe5-9d58-e4d59b89d8f0","object":"chat.completion.chunk","created":1709899323,"model":"step-3.7-flash","choices":[{"index":0,"delta":{"role":"","content":"!"},"finish_reason":""}],"usage":{"prompt_tokens":83,"completion_tokens":3,"total_tokens":86}}

...

data: {"id":"d7ae7c4a-1524-4fe5-9d58-e4d59b89d8f0","object":"chat.completion.chunk","created":1709899323,"model":"step-3.7-flash","choices":[{"index":0,"delta":{"role":"","content":""},"finish_reason":"stop"}],"usage":{"prompt_tokens":83,"completion_tokens":150,"total_tokens":233}}

data: [DONE]

示例

说明:以下基础示例默认使用 step-3.5-flash。如需使用三档推理强度,可参考「推理强度」示例中的 step-3.7-flash 调用方式。
curl https://api.stepfun.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $STEPFUN_API_KEY" \
  -d '{
    "model": "step-3.7-flash",
    "messages": [
      {
        "role": "user",
        "content": "请用三句话解释什么是强化学习。"
      }
    ],
    "reasoning_effort": "medium",
    "max_tokens": 1024
  }'