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"
  }
}

不同模型、配额状态及 API 密钥条件可能产生不同的错误信息。客户端应同时依据 HTTP 状态码和 error.message 字段进行妥善的错误处理。

常用端点

方法	路径	说明
`POST`	`/chat/completions`	创建聊天补全。
`GET`	`/models`	获取当前可用模型列表；是否开放以当前服务端为准。

流式响应

TokiAI 支持 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 || '');
}