快速开始
SUBR 提供与 OpenAI 兼容的 API 接口。你可以在 3 分钟内完成集成，开始调用大模型。
获取 API Key
注册 SUBR 账号后，在控制台创建一个新的 API Key。请妥善保管你的密钥，不要泄露给他人。
💡 提示： 你可以创建多个 API Key 用于不同项目，并分别为它们设置用量限制。
发起第一个请求
使用 cURL 快速验证你的 API Key 是否可用：
curl https://api.subr.dev/v1/chat/completions \
-H "Authorization: Bearer sk-xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{
"model": "gpt-4o",
"messages": [
{"role": "user", "content": "你好，请用中文回复"}
]
}'
身份验证
所有 API 请求需要在 HTTP Header 中携带你的 API Key 进行身份验证。
# 推荐方式：Bearer Token
Authorization: Bearer sk-xxxxxxxxxxxx
所有 API 请求必须在 Header 中传递 Authorization 字段。未认证的请求将返回 401 Unauthorized。
模型列表
获取当前可用的所有模型：
curl https://api.subr.dev/v1/models \
-H "Authorization: Bearer sk-xxxxxxxx"
返回示例：
{
"data": [
{ "id": "gpt-4o", "object": "model", "created": 1700000000 },
{ "id": "claude-3.5-sonnet", "object": "model", "created": 1700000001 },
{ "id": "deepseek-v3", "object": "model", "created": 1700000002 }
]
}
聊天补全
POST /v1/chat/completions
向指定模型发送聊天消息并获取补全结果。
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|
model | string | 是 | 模型 ID，如 gpt-4o |
messages | array | 是 | 消息列表，支持 role: system/user/assistant |
temperature | number | 否 | 采样温度，0-2 之间，默认 1 |
max_tokens | integer | 否 | 最大生成 Token 数，默认 4096 |
stream | boolean | 否 | 是否流式输出，默认 false |
请求示例
const res = await fetch('https://api.subr.dev/v1/chat/completions', {
method: 'POST',
headers: {
'Authorization': 'Bearer sk-xxxxxxxx',
'Content-Type': 'application/json'
},
body: JSON.stringify({
model: 'gpt-4o',
messages: [{ role: 'user', content: 'Hello' }],
temperature: 0.7
})
});
const data = await res.json();
向量嵌入
POST /v1/embeddings
将文本转换为向量表示，适用于语义搜索、聚类等场景。
curl https://api.subr.dev/v1/embeddings \
-H "Authorization: Bearer sk-xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"model": "text-embedding-3", "input": "SUBR API 真方便"}'
图像生成
POST /v1/images/generations
通过文本描述生成图像，支持 DALL·E 3、Stable Diffusion 3 等模型。
curl https://api.subr.dev/v1/images/generations \
-H "Authorization: Bearer sk-xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"model": "dall-e-3", "prompt": "A serene mountain landscape at sunset", "n": 1}'
Python SDK
安装 SUBR Python SDK：
pip install subr-sdk
基本使用：
from subr import SUBR
client = SUBR(api_key="sk-xxxxxxxx")
# 聊天补全
response = client.chat.completions.create(
model="gpt-4o",
messages=[{"role": "user", "content": "你好"}]
)
print(response.choices[0].message.content)
Node.js SDK
安装：
npm install subr-sdk
基本使用：
import SUBR from 'subr-sdk';
const client = new SUBR({ apiKey: 'sk-xxxxxxxx' });
// 流式输出
const stream = await client.chat.completions.create({
model: 'gpt-4o',
messages: [{ role: 'user', content: '讲个笑话' }],
stream: true
});
for await (const chunk of stream) {
process.stdout.write(chunk.choices[0]?.delta?.content || '');
}