快速开始

申请API密钥

你可以在开放平台账号管理子菜单接口密钥中获取API密钥

环境准备

Python依赖安装

对 python 用户，可以复用 openai 的 sdk


pip install --upgrade 'openai>=1.0'

cURL环境安装

在不同的操作系统上安装curl命令，会使用不同的包管理器。以下是在Debian、CentOS和macOS上安装curl的命令：

Debian/Ubuntu (使用apt包管理器):


sudo apt-get update
sudo apt-get install curl

CentOS (使用yum或dnf包管理器, CentOS 8 或更高版本使用dnf):
- 使用yum:
```
sudo yum install curl
```
- 使用dnf(CentOS 8):
```
sudo dnf install curl
```
macOS (使用brew包管理器, 如果尚未安装Homebrew，可以参考Homebrew官网进行安装):
```
brew install curl
```

发送请求

在安装好环境依赖并申请了API密钥之后，可以使用python库或者curl发送请求。下列是简单的python以及curl示例：


from openai import OpenAI
 
client = OpenAI(api_key="STEP_API_KEY", base_url="https://api.stepfun.com/v1")
 
completion = client.chat.completions.create(
	model="step-1-8k",
	messages=[
		{
			"role": "system",
			"content": "你是由阶跃星辰提供的AI聊天助手，你擅长中文，英文，以及多种其他语言的对话。在保证用户数据安全的前提下，你能对用户的问题和请求，作出快速和精准的回答。同时，你的回答和建议应该拒绝黄赌毒，暴力恐怖主义的内容",
		},
		{"role": "user", "content": "你好，请介绍一下阶跃星辰的人工智能!"},
	],
)
 
print(completion)

响应请求

stream和非stream返回类似如下：


{
	"id": "780ed6b9fefd60c3b2589eb784bd478c@018f5c55f3fe7b618d43c1780b6b3205",
	"object": "chat.completion",
	"created": 1715241088,
	"model": "step-1-8k",
	"choices": [
		{
			"index": 0,
			"message": {
				"role": "assistant",
				"content": "阶跃星辰的人工智能是一种基于先进算法和大数据技术的智能系统。它旨在为用户提供智能化的解决方案和服务，包括自然语言处理、智能推荐、图像识别、语音识别等功能。\n\n作为AI聊天助手，我可以与用户进行多种语言的对话，并根据用户的问题和请求提供快速、精准的回答。我还可以根据用户的偏好和历史记录，提供个性化的建议和推荐。\n\n阶跃星辰的人工智能注重用户数据的安全和隐私保护，严格遵守相关法律法规，确保用户的数据不会被滥用或泄露。同时，我也会拒绝黄赌毒、暴力恐怖主义等不良内容，为用户提供健康、积极的交流环境。"
			},
			"finish_reason": "stop"
		}
	],
	"usage": {
		"prompt_tokens": 85,
		"completion_tokens": 143,
		"total_tokens": 228
	}
}

部分异常响应如下(详细错误信息可以参考错误码文档)：

请求超时机制：我们为每个请求设定了一个时间限制，即10分钟。如果在这个时间限制内请求没有完成，系统将不会继续等待，而是立即终止该请求，并返回一个状态码为503的错误响应。
速率限制：系统还设置了速率限制来控制请求的频率。如果用户的请求频率超过了这个限制，系统将不会处理超出限制的请求，而是直接返回一个状态码为429的错误响应。这个错误表示“太多请求”，意味着用户在给定的时间窗口内发送了太多的请求。