API 接入文档
EHXALI API 完全兼容 OpenAI API 格式,可无缝替换现有 OpenAI 调用代码。
快速开始
1. 获取 API Key
- 注册并登录 EHXALI 平台
- 进入 API Keys 管理 页面
- 点击"创建 API Key"按钮
- 妥善保存生成的 API Key(格式:
sk-xxxxxxxx)
2. 充值账户
3. 调用 API
Base URL
https://api.hx12.top/v1
Chat Completions
curl https://api.hx12.top/v1/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer sk-your-api-key" \
-d '{
"model": "gpt-4",
"messages": [
{"role": "system", "content": "You are a helpful assistant."},
{"role": "user", "content": "Hello!"}
],
"stream": false
}'
Python 示例
import openai
client = openai.OpenAI(
api_key="sk-your-api-key",
base_url="https://api.hx12.top/v1"
)
response = client.chat.completions.create(
model="gpt-4",
messages=[
{"role": "user", "content": "Hello!"}
]
)
print(response.choices[0].message.content)
Node.js 示例
import OpenAI from 'openai';
const client = new OpenAI({
apiKey: 'sk-your-api-key',
baseURL: 'https://api.hx12.top/v1'
});
const response = await client.chat.completions.create({
model: 'gpt-4',
messages: [{ role: 'user', content: 'Hello!' }]
});
console.log(response.choices[0].message.content);
支持的接口
| 接口 | 方法 | 说明 |
|---|---|---|
/v1/chat/completions |
POST | 对话补全(支持流式) |
/v1/embeddings |
POST | 文本向量化 |
/v1/models |
GET | 获取可用模型列表 |
/v1/models/{model_id} |
GET | 获取模型详情 |
支持的模型
暂无可用模型,请联系管理员。
错误码说明
| HTTP 状态码 | 错误类型 | 说明 |
|---|---|---|
| 401 | invalid_api_key |
API Key 无效 |
| 402 | insufficient_balance |
余额不足 |
| 404 | model_not_found |
模型不存在 |
| 429 | rate_limit_exceeded |
请求过于频繁 |
| 502 | upstream_error |
上游服务错误 |
OAuth 2.0 接入
第三方应用可通过 OAuth 2.0 授权获取用户 API Key,详见 OAuth 接入文档。
安全提示:请妥善保管您的 API Key,不要将其暴露在前端代码或公开的代码仓库中。