API Reference
接入 OKKToken
开始构建
兼容 OpenAI 与 Anthropic 双协议,原生支持流式响应。 将现有代码的 Base URL 替换为我们的地址,即可无缝迁移。
OpenAI 兼容
Anthropic 兼容
SSE 流式
Authentication
认证
所有请求均需在 HTTP 请求头中携带 API Key。
● 请求头格式(二选一)
# OpenAI 兼容客户端 Authorization: Bearer sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx # Claude 原生客户端(如 Chatbox Claude API 模式) x-api-key: sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
请妥善保管你的 API Key,不要将其提交到代码仓库或暴露在客户端代码中。
Base URL
接入地址
根据所使用的协议选择对应的 Base URL。
OpenAI
https://api.okktoken.com
Anthropic
https://api.okktoken.com
两套协议共用同一域名,通过请求路径自动区分。
/v1/messages 走 Anthropic 上游,其余走 OpenAI 上游。
Endpoints
API 接口
POST
/chat/completions
OpenAI Chat 补全
▶
与 OpenAI
POST /v1/chat/completions 完全兼容,支持流式与非流式响应。
| 参数 | 类型 | 说明 |
|---|---|---|
| modelrequired | string | 模型名称,如 gpt-4o、gpt-4o-mini |
| messagesrequired | array | 对话消息列表,每条包含 role 和 content |
| streamoptional | boolean | 是否启用流式响应,默认 false |
| temperatureoptional | number | 采样温度,范围 0–2,默认 1 |
| max_tokensoptional | integer | 最大生成 token 数 |
curl
curl https://api.okktoken.com/chat/completions \ -H "Authorization: Bearer sk-your-key" \ -H "Content-Type: application/json" \ -d '{ "model": "gpt-4o", "messages": [ {"role": "system", "content": "You are a helpful assistant."}, {"role": "user", "content": "Hello!"} ], "stream": false }'
POST
/v1/responses
OpenAI Responses API
▶
兼容 OpenAI
POST /v1/responses 接口,支持多轮对话与工具调用。
curl
curl https://api.okktoken.com/v1/responses \ -H "Authorization: Bearer sk-your-key" \ -H "Content-Type: application/json" \ -d '{ "model": "gpt-4o", "input": "Tell me a joke." }'
POST
/v1/messages
Anthropic Messages
▶
与 Anthropic
POST /v1/messages 完全兼容。网关会自动处理鉴权协议转换,客户端只需传标准 API Key 即可。
| 参数 | 类型 | 说明 |
|---|---|---|
| modelrequired | string | 模型名称,如 claude-opus-4-6、claude-sonnet-4-5 |
| messagesrequired | array | 对话消息列表 |
| max_tokensrequired | integer | 最大生成 token 数,Anthropic 要求必填 |
| streamoptional | boolean | 是否启用流式响应 |
curl
curl https://api.okktoken.com/v1/messages \ -H "Authorization: Bearer sk-your-key" \ -H "Content-Type: application/json" \ -d '{ "model": "claude-opus-4-6", "max_tokens": 1024, "messages": [ {"role": "user", "content": "Hello, Claude!"} ] }'
GET
/models
获取可用模型列表
▶
返回当前可用的所有模型。也可通过
GET /models/{model} 查询单个模型详情。
curl
curl https://api.okktoken.com/models \ -H "Authorization: Bearer sk-your-key"
Streaming
流式响应
设置 "stream": true 即可启用 SSE 流式输出,实时获取生成内容。
流式模式下,OpenAI 接口会自动注入
stream_options.include_usage,最终 chunk 包含完整 token 统计。
Python 示例
python
# OpenAI SDK — 只需替换 base_url from openai import OpenAI client = OpenAI( api_key="sk-your-key", base_url="https://api.okktoken.com", ) stream = client.chat.completions.create( model="gpt-4o", messages=[{"role": "user", "content": "Hello!"}], stream=True, ) for chunk in stream: print(chunk.choices[0].delta.content, end="")
SDK
SDK 快速接入
无需修改业务代码,仅替换 api_key / base_url 参数即可。
bash — 安装
pip install openai
python
from openai import OpenAI client = OpenAI( api_key="sk-your-key", base_url="https://api.okktoken.com", ) response = client.chat.completions.create( model="gpt-4o", messages=[{"role": "user", "content": "Hello!"}], ) print(response.choices[0].message.content)
bash — 安装
npm install openai
javascript
import OpenAI from 'openai' const client = new OpenAI({ apiKey: 'sk-your-key', baseURL: 'https://api.okktoken.com', }) const res = await client.chat.completions.create({ model: 'gpt-4o', messages: [{ role: 'user', content: 'Hello!' }], }) console.log(res.choices[0].message.content)
bash — 安装
pip install anthropic
python
import anthropic client = anthropic.Anthropic( api_key="sk-your-key", base_url="https://api.okktoken.com", ) message = client.messages.create( model="claude-opus-4-6", max_tokens=1024, messages=[{"role": "user", "content": "Hello, Claude!"}], ) print(message.content[0].text)
Errors
错误码
所有错误响应均返回 JSON,包含 error 字段描述原因。
错误响应格式
json
{
"error": "invalid or disabled api key"
}