Skip to main content

Documentation Index

Fetch the complete documentation index at: https://platform.stepfun.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
1. Prepare Your Account and API Key

Before you start configuring, first make sure your account has an available Step Plan and that you have prepared a Step API Key. They determine whether you can enable calling capabilities normally, as well as the authentication and authorization of subsequent requests.
Recommended order: first confirm that you have subscribed to or activated a Step Plan, then create an API Key, and finally integrate a specific tool.

​
Subscribe to a Step Plan

If this is your first time using the open platform, it is recommended to first check whether your current account has completed Step Plan subscription or activation. In general, only after you have an available package, plan, or corresponding calling permissions will subsequent model calls, quota usage, and capability usage take effect properly. If your account has already been enabled by your team, you can go directly to the next step. If it has not been enabled yet, it is recommended to first complete the subscription to the corresponding plan on the platform, and then continue to create an API Key and integrate third-party tools.

​
Obtain an API Key

How to obtain it: It is recommended that you create a new API Key in the console and keep it safe. Do not write it directly into your code repository. For your first integration, it is recommended to prioritize using the following model for verification: 
step-3.5-flash
In different tools, you will frequently see these configuration items:
  • API Provider: Select the interface provider type, such as OpenAI Compatible
  • Base URL: Choose the model service address based on the protocol used by the tool. For the Chat Completions API (OpenAI-compatible) or OpenAI Compatible tools, use https://api.stepfun.ai/step_plan/v1. For the Messages API (Anthropic-compatible), use https://api.stepfun.ai/step_plan.
  • API Key: The key obtained from the Step platform
  • Model or Model ID: Enter step-3.5-flash
Note: When manually editing the Claude Code configuration file, set ANTHROPIC_BASE_URL to the Messages API (Anthropic-compatible) base URL: https://api.stepfun.ai/step_plan (without /v1). Claude Code automatically appends /v1/messages when making requests.

​
2. Choose an Integration Tool

If you have not yet decided which tool to use, you can first choose based on your way of working:

​
Common Checks

If the call fails, check the following items first:
  • Whether the API Key is entered correctly and belongs to the correct environment
  • Whether the Base URL matches the tool protocol: use https://api.stepfun.ai/step_plan/v1 for the Chat Completions API (OpenAI-compatible) or OpenAI Compatible tools, and https://api.stepfun.ai/step_plan for the Messages API (Anthropic-compatible) or Claude Code configuration files
  • Whether Model or Model ID is set to step-3.5-flash
  • Whether the tool has already saved the configuration and been restarted