API 文档
Taran AI 完全兼容 OpenAI Chat Completions 接口,替换 base_url 与 API Key 即可接入。
快速开始
- 1. 在 控制台 注册并登录
- 2. 在控制台创建 API Key(形如
sk-taran-…) - 3. 将请求发送至
/v1/chat/completions,认证方式:Authorization: Bearer <API Key>
认证
所有 /v1/* 接口均需 API Key 认证。 API Key 创建后仅显示一次,服务端只存储 SHA-256 哈希。
对话补全(非流式)
curl
curl http://localhost:3000/v1/chat/completions \
-H "Authorization: Bearer sk-taran-你的APIKey" \
-H "Content-Type: application/json" \
-d '{
"model": "gpt-4o-mini",
"messages": [
{"role": "system", "content": "你是一个乐于助人的助手。"},
{"role": "user", "content": "用一句话介绍你自己"}
]
}'返回标准 chat.completion 对象,含 choices 与 usage(Token 用量)。
对话补全(SSE 流式)
curl
curl -N http://localhost:3000/v1/chat/completions \
-H "Authorization: Bearer sk-taran-你的APIKey" \
-H "Content-Type: application/json" \
-d '{
"model": "deepseek-chat",
"messages": [{"role": "user", "content": "写一首关于月亮的短诗"}],
"stream": true
}'设置 stream: true 即返回 SSE 事件流,以 data: [DONE] 结束。
Python 示例(openai 官方 SDK)
python
from openai import OpenAI
client = OpenAI(
api_key="sk-taran-你的APIKey",
base_url="http://localhost:3000/v1",
)
resp = client.chat.completions.create(
model="gpt-4o-mini",
messages=[{"role": "user", "content": "你好,介绍一下你自己"}],
)
print(resp.choices[0].message.content)
# 流式调用
stream = client.chat.completions.create(
model="deepseek-chat",
messages=[{"role": "user", "content": "你好"}],
stream=True,
)
for chunk in stream:
if chunk.choices[0].delta.content:
print(chunk.choices[0].delta.content, end="")Node.js 示例(fetch)
javascript
const BASE = 'http://localhost:3000/v1';
const KEY = 'sk-taran-你的APIKey';
const res = await fetch(BASE + '/chat/completions', {
method: 'POST',
headers: { 'Content-Type': 'application/json', Authorization: 'Bearer ' + KEY },
body: JSON.stringify({
model: 'gpt-4o-mini',
messages: [{ role: 'user', content: '你好' }],
}),
});
const data = await res.json();
console.log(data.choices[0].message.content);
console.log('usage:', data.usage);模型列表
curl
curl http://localhost:3000/v1/models \
-H "Authorization: Bearer sk-taran-你的APIKey"返回 OpenAI 兼容的模型列表:object: list + data[]。
计费说明
每次调用按实际 Token 用量扣费:费用 = 输入Token × 输入单价 + 输出Token × 输出单价(单价以每百万 Token 计,见模型广场)。 余额不足时返回 402。调用记录与控制台用量统计可在「控制台」中查看。
错误码
| 状态码 | 错误类型 | 说明 |
|---|---|---|
| 400 | invalid_request_error | 请求体格式错误(缺少 model / messages) |
| 401 | invalid_api_key | API Key 缺失或无效 |
| 402 | insufficient_quota | 余额不足,请充值 |
| 404 | model_not_found | 模型不存在或未启用 |
| 502 | upstream_error | 上游通道连接失败(real 模式) |
| 503 | upstream_error | 未配置可用上游通道(real 模式) |