快速开始

本指南提供一套通用调用示例。先从下表选择模型 ID，再在下方横向标签中切换文本对话、图片理解或视频理解。

选择模型 ID

模型	Model ID	输入能力
Step 5 Preview	`step-5-preview`	文本、图片、视频
Step 3.7 Flash	`step-3.7-flash`	文本、图片、视频
Step 3.5 Flash	`step-3.5-flash`	仅文本

将下面示例中的 YOUR_MODEL_ID 替换为上表中的 Model ID，并将 YOUR_STEP_API_KEY 替换为您的 API Key。文档中的 YOUR_STEP_API_KEY 是待替换的密钥占位符，不是真实密钥。STEP_API_KEY、STEPFUN_API_KEY 等是示例或工具使用的变量名；例如 export STEPFUN_API_KEY="YOUR_STEP_API_KEY" 设置变量，Bearer $STEPFUN_API_KEY 读取其值。请保持同一示例的变量名一致，并保留工具要求的配置字段名。

申请 API 密钥

环境准备

Python 依赖安装

Python 示例使用 OpenAI SDK：

macOS / Linux
Windows

python3 -m pip install --upgrade "openai>=1.0"

py -m pip install --upgrade "openai>=1.0"

发送请求

文本对话
图片理解
视频理解

适用于三个模型。将 YOUR_MODEL_ID 替换为要调用的模型 ID。

Python
cURL

from openai import OpenAI

client = OpenAI(
    api_key="YOUR_STEP_API_KEY",
    base_url="https://api.stepfun.com/v1",
)

response = client.chat.completions.create(
    model="YOUR_MODEL_ID",
    messages=[
        {"role": "user", "content": "你好，请用一句话介绍你自己。"}
    ],
)

print(response.choices[0].message.content)

curl https://api.stepfun.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_STEP_API_KEY" \
  -d '{
    "model": "YOUR_MODEL_ID",
    "messages": [
      {
        "role": "user",
        "content": "你好，请用一句话介绍你自己。"
      }
    ]
  }'

Step 5 Preview 和 Step 3.7 Flash 支持图片输入。Step 3.5 Flash 不支持图片输入，请改用支持图片的模型。

Python
cURL

from openai import OpenAI

client = OpenAI(
    api_key="YOUR_STEP_API_KEY",
    base_url="https://api.stepfun.com/v1",
)

response = client.chat.completions.create(
    model="YOUR_MODEL_ID",
    messages=[{
        "role": "user",
        "content": [
            {"type": "text", "text": "请提取图中的关键信息并概括主要结论。"},
            {
                "type": "image_url",
                # 请将此占位地址替换为您自己的可访问图片 URL。
                "image_url": {"url": "https://example.com/image.jpg"},
            },
        ],
    }],
)

print(response.choices[0].message.content)

# 请将此占位地址替换为您自己的可访问图片 URL。
curl https://api.stepfun.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_STEP_API_KEY" \
  -d '{
    "model": "YOUR_MODEL_ID",
    "messages": [{
      "role": "user",
      "content": [
        {"type": "text", "text": "请提取图中的关键信息并概括主要结论。"},
        {
          "type": "image_url",
          "image_url": {"url": "https://example.com/image.jpg"}
        }
      ]
    }]
  }'

Step 5 Preview 和 Step 3.7 Flash 支持通过 video_url 传入视频。Step 3.5 Flash 不支持视频输入，请改用支持视频的模型。

Python
cURL

from openai import OpenAI

client = OpenAI(
    api_key="YOUR_STEP_API_KEY",
    base_url="https://api.stepfun.com/v1",
)

response = client.chat.completions.create(
    model="YOUR_MODEL_ID",
    messages=[{
        "role": "user",
        "content": [
            {"type": "text", "text": "请按时间顺序总结视频中的主要内容。"},
            {
                "type": "video_url",
                # 请将此占位地址替换为您自己的可访问视频 URL。
                "video_url": {"url": "https://example.com/video.mp4"},
            },
        ],
    }],
)

print(response.choices[0].message.content)

# 请将此占位地址替换为您自己的可访问视频 URL。
curl https://api.stepfun.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_STEP_API_KEY" \
  -d '{
    "model": "YOUR_MODEL_ID",
    "messages": [{
      "role": "user",
      "content": [
        {"type": "text", "text": "请按时间顺序总结视频中的主要内容。"},
        {
          "type": "video_url",
          "video_url": {"url": "https://example.com/video.mp4"}
        }
      ]
    }]
  }'

响应请求

非流式请求的生成内容位于 choices[0].message.content：

{
  "model": "所选模型 ID",
  "choices": [
    {
      "message": {
        "role": "assistant",
        "content": "模型生成的回复"
      },
      "finish_reason": "stop"
    }
  ]
}

完整响应还包含请求 ID、token 用量等字段，详见 Chat Completions API。如果请求失败，请根据返回的错误信息查阅错误码文档。

深入使用

模型能力总览

对比 Step 5 Preview、Step 3.7 Flash 和 Step 3.5 Flash 的定位与能力。

图片理解最佳实践

查看图片格式、传入方式和参数建议。

视频理解最佳实践

查看视频输入方式、限制和常见问题。

API 参考

查看完整请求参数、响应字段和用量信息。

开始使用

公告

模型

定价计费

团队与组织

条款与协议

帮助与支持

选择模型 ID

申请 API 密钥

环境准备

Python 依赖安装

发送请求

响应请求

深入使用

模型能力总览

图片理解最佳实践

视频理解最佳实践

API 参考

​选择模型 ID

​申请 API 密钥

​环境准备

​Python 依赖安装

​发送请求

​响应请求

​深入使用

模型能力总览

图片理解最佳实践

视频理解最佳实践

API 参考

选择模型 ID

申请 API 密钥

环境准备

Python 依赖安装

发送请求

响应请求

深入使用