API 接口文档
RuiQ AI 算力网关服务 API,支持标准 OpenAI 兼容接口调用方式。
基础信息
接口地址
Base URL: https://ruiqai.com/v1
认证方式
所有请求需要在 Header 中携带 API Key:
Authorization: Bearer YOUR_API_KEY
请求格式
请求体为 JSON 格式,Content-Type: application/json
模型列表
GET/v1/models
查询当前可用的模型列表。
请求示例
curl https://ruiqai.com/v1/models \ -H "Authorization: Bearer YOUR_API_KEY"
响应示例
{
"data": [
{
"id": "deepseek-chat",
"object": "model",
"created": 1700000000,
"owned_by": "deepseek"
},
{
"id": "glm-4-flash",
"object": "model",
"owned_by": "zhipuai"
}
]
}
对话补全
POST/v1/chat/completions
发送对话请求,返回模型生成的回复。兼容 OpenAI Chat Completions API 格式。
请求参数
modelstring — 模型ID,如deepseek-chat、glm-4-flash、qwen-turbomessagesarray — 对话消息数组,每条包含role(system/user/assistant)和content(内容)temperaturefloat 可选 — 采样温度,范围 0~2,默认 1.0max_tokensint 可选 — 最大生成 Token 数streambool 可选 — 是否启用流式输出,默认 false
请求示例
curl https://ruiqai.com/v1/chat/completions \ -H "Content-Type: application/json" \ -H "Authorization: Bearer YOUR_API_KEY" \ -d '{ "model": "deepseek-chat", "messages": [ {"role": "system", "content": "你是一个助手。"}, {"role": "user", "content": "你好,介绍一下自己。"} ], "temperature": 0.7, "max_tokens": 512 }'
响应示例
{
"id": "chatcmpl-xxx",
"object": "chat.completion",
"created": 1710000000,
"model": "deepseek-chat",
"choices": [{
"index": 0,
"message": {
"role": "assistant",
"content": "您好!我是..."
},
"finish_reason": "stop"
}]
}
Token 用量查询
GET/v1/user/usage
查询当前账户的 Token 使用量与余额信息。
响应示例
{
"total_usage": 1250000,
"balance": 875.50,
"unit": "元"
}
错误代码
401— API Key 无效或未提供403— 账户余额不足或权限不足429— 请求频率超限,请降低调用频率500— 服务器内部错误,请稍后重试503— 服务暂时不可用
SDK 调用示例
Python(OpenAI SDK)
from openai import OpenAI client = OpenAI( api_key="YOUR_API_KEY", base_url="https://ruiqai.com/v1" ) response = client.chat.completions.create( model="deepseek-chat", messages=[ {"role": "user", "content": "你好"} ] ) print(response.choices[0].message.content)
JavaScript(Node.js)
import OpenAI from 'openai'; const client = new OpenAI({ apiKey: 'YOUR_API_KEY', baseURL: 'https://ruiqai.com/v1' }); const chat = await client.chat.completions.create({ model: 'deepseek-chat', messages: [{ role: 'user', content: '你好' }] }); console.log(chat.choices[0].message.content);