API 参考
API 概览
TOKI OpenAI 兼容 REST API 端点和约定概述。
基础 URL
所有 API 请求应发送到:
https://www.tokiai.ai/v1请求格式
- 所有请求必须使用 HTTPS
- 请求体应为 JSON 编码
- 需包含
Content-Type: application/json请求头 - 需包含
Authorization: Bearer YOUR_API_KEY请求头
响应格式
聊天补全响应遵循 OpenAI Chat Completions 的常用结构:
{
"id": "chatcmpl-abc123",
"object": "chat.completion",
"created": 1714000000,
"model": "deepseek/deepseek-chat-v3",
"choices": [...],
"usage": {
"prompt_tokens": 10,
"completion_tokens": 20,
"total_tokens": 30
}
}错误处理
错误通常返回相应的 HTTP 状态码和 JSON 错误体:
| 状态码 | 说明 |
|---|---|
| 400 | 请求错误 — 参数无效 |
| 401 | 未授权 — API 密钥无效 |
| 403 | 禁止访问 — 权限不足 |
| 429 | 请求过多 — 超出速率限制 |
| 500 | 服务器内部错误 |
{
"error": {
"code": "invalid_request",
"message": "'model' 字段为必填项。",
"type": "invalid_request_error"
}
}不同模型、额度和密钥状态可能返回不同错误信息。客户端应读取 error.message 并结合 HTTP 状态码处理。
常用端点
| 方法 | 路径 | 说明 |
|---|---|---|
POST | /chat/completions | 创建聊天补全。 |
GET | /models | 获取当前可用模型列表;是否开放以当前服务端为准。 |
流式响应
TOKI 支持通过 Server-Sent Events (SSE) 进行流式响应。在请求中设置 stream: true:
const stream = await openai.chat.completions.create({
model: 'deepseek/deepseek-chat-v3',
messages: [{ role: 'user', content: '给我讲个故事' }],
stream: true,
});
for await (const chunk of stream) {
process.stdout.write(chunk.choices[0]?.delta?.content || '');
}