API 参考
本文档提供庆霄云计算 API Key 分发服务的完整 API 参考。
API 概述
基础信息
- API 基础地址:
https://api.qingxiao.cloud/v1 - 协议: HTTPS
- 数据格式: JSON
- 字符编码: UTF-8
认证方式
所有 API 请求都需要在请求头中携带 API Key:
Authorization: Bearer sk-xxxxxxxxxxxx
通用响应格式
{
"code": 0,
"message": "success",
"data": {
// 响应数据
}
}
错误码说明
| 错误码 | 说明 |
|---|---|
| 0 | 成功 |
| 1001 | 参数错误 |
| 1002 | 认证失败 |
| 1003 | 权限不足 |
| 1004 | 资源不存在 |
| 2001 | 余额不足 |
| 2002 | 调用限额超限 |
| 2003 | API Key 已过期 |
| 3001 | 服务暂时不可用 |
| 3002 | 请求频率超限 |
对话模型 API
创建对话补全
请求
POST /chat/completions
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| model | string | 是 | 模型名称,如 gpt-4、gpt-3.5-turbo、claude-3-opus |
| messages | array | 是 | 对话消息数组 |
| temperature | number | 否 | 温度参数,0-2,默认 1 |
| max_tokens | integer | 否 | 最大输出 Token 数 |
| stream | boolean | 否 | 是否启用流式响应,默认 false |
请求示例
curl -X POST https://api.qingxiao.cloud/v1/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer sk-xxxxxxxxxxxx" \
-d '{
"model": "gpt-3.5-turbo",
"messages": [
{"role": "system", "content": "你是一个有帮助的助手。"},
{"role": "user", "content": "你好,请介绍一下自己"}
],
"temperature": 0.7,
"max_tokens": 500
}'
响应示例
{
"code": 0,
"message": "success",
"data": {
"id": "chatcmpl-xxxxx",
"object": "chat.completion",
"created": 1681234567,
"model": "gpt-3.5-turbo",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "你好!我是庆霄云计算的AI助手..."
},
"finish_reason": "stop"
}
],
"usage": {
"prompt_tokens": 20,
"completion_tokens": 100,
"total_tokens": 120
}
}
}
图像模型 API
创建图像
请求
POST /images/generations
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| model | string | 是 | 模型名称,如 dall-e-3 |
| prompt | string | 是 | 图像描述 |
| n | integer | 否 | 生成图像数量,默认 1 |
| size | string | 否 | 图像尺寸,如 1024x1024 |
请求示例
curl -X POST https://api.qingxiao.cloud/v1/images/generations \
-H "Content-Type: application/json" \
-H "Authorization: Bearer sk-xxxxxxxxxxxx" \
-d '{
"model": "dall-e-3",
"prompt": "一只可爱的猫咪在阳光下打盹",
"n": 1,
"size": "1024x1024"
}'
响应示例
{
"code": 0,
"message": "success",
"data": {
"created": 1681234567,
"data": [
{
"url": "https://cdn.qingxiao.cloud/images/xxxxx.png"
}
]
}
}
语音模型 API
语音识别
请求
POST /audio/transcriptions
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| model | string | 是 | 模型名称,如 whisper-1 |
| file | file | 是 | 音频文件 |
| language | string | 否 | 语言代码,如 zh、en |
请求示例
curl -X POST https://api.qingxiao.cloud/v1/audio/transcriptions \
-H "Authorization: Bearer sk-xxxxxxxxxxxx" \
-F model="whisper-1" \
-F file="@audio.mp3"
API Key 管理 API
创建 API Key
请求
POST /keys/create
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| name | string | 是 | 密钥名称 |
| daily_limit | integer | 否 | 每日调用限额 |
| expires_at | string | 否 | 过期时间(ISO 8601 格式) |
请求示例
curl -X POST https://api.qingxiao.cloud/v1/keys/create \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {管理密钥}" \
-d '{
"name": "生产环境密钥",
"daily_limit": 10000,
"expires_at": "2026-12-31T23:59:59Z"
}'
查询 API Key 列表
请求
GET /keys/list
删除 API Key
请求
DELETE /keys/{key_id}
用量统计 API
查询用量统计
请求
GET /usage/stats?start_date=2026-04-01&end_date=2026-04-30
响应示例
{
"code": 0,
"message": "success",
"data": {
"total_calls": 15000,
"total_tokens": 500000,
"total_cost": 60.00,
"daily_stats": [
{
"date": "2026-04-01",
"calls": 500,
"tokens": 16000,
"cost": 1.92
}
]
}
}
SDK 使用示例
Python SDK
from qingxiao import Client
# 初始化客户端
client = Client(api_key="sk-xxxxxxxxxxxx")
# 对话补全
response = client.chat.completions.create(
model="gpt-3.5-turbo",
messages=[
{"role": "user", "content": "你好"}
]
)
print(response.choices[0].message.content)
JavaScript SDK
const Qingxiao = require('qingxiao-sdk');
// 初始化客户端
const client = new Qingxiao({
apiKey: 'sk-xxxxxxxxxxxx'
});
// 对话补全
async function chat() {
const response = await client.chat.completions.create({
model: 'gpt-3.5-turbo',
messages: [
{ role: 'user', content: '你好' }
]
});
console.log(response.choices[0].message.content);
}
chat();
速率限制
不同套餐的速率限制:
| 套餐 | 每分钟请求数 | 每分钟 Token 数 |
|---|---|---|
| 免费版 | 20 | 40000 |
| 基础版 | 60 | 100000 |
| 标准版 | 200 | 300000 |
| 专业版 | 500 | 1000000 |
| 企业版 | 2000 | 5000000 |
联系支持
如有 API 使用问题,请联系技术支持:
- 邮箱:support@qingxiao.cloud
- 工单:控制台 → 工单系统
