Appearance
API 参考
BeesAI 提供完全兼容 OpenAI API 的 RESTful 接口。
Base URL
| 环境 | Base URL |
|---|---|
| 生产环境 | https://beesai.cn/v1 |
认证方式
所有请求需要在 Header 中携带 API Key:
Authorization: Bearer sk-你的API密钥获取 API Key
登录控制台 → 令牌管理 → 创建新令牌
核心接口
对话补全 (Chat Completions)
创建一个聊天对话请求。
Endpoint: POST /v1/chat/completions
请求参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
model | string | ✅ | 模型 ID |
messages | array | ✅ | 对话消息列表 |
temperature | number | ❌ | 温度参数 (0-2),默认 1 |
max_tokens | number | ❌ | 最大生成 token 数 |
stream | boolean | ❌ | 是否流式输出,默认 false |
消息格式:
json
{
"role": "system | user | assistant",
"content": "消息内容"
}成功响应:
json
{
"id": "chatcmpl-xxx",
"object": "chat.completion",
"model": "gpt-4o",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "Hello! How can I help you?"
},
"finish_reason": "stop"
}
],
"usage": {
"prompt_tokens": 10,
"completion_tokens": 8,
"total_tokens": 18
}
}模型列表 (Models)
Endpoint: GET /v1/models
返回所有可用模型的列表。
Token 用量查询
Endpoint: GET /v1/dashboard/billing/usage
查询当前账户的 token 使用情况。
错误码
详见 错误码说明。