对外接入只需要两步:先调用邀请注册接口拿到用户信息和默认 API Key,再使用这个 API Key 调用 OpenAI 兼容的 AI 接口。
| 步骤 | 说明 | 接口 |
|---|---|---|
| 1 | 调用邀请注册接口,自动创建用户并获取 API Key | POST /api/auth/register |
| 2 | 使用 API Key 调用 AI 模型 | POST /v1/chat/completions |
所有需要认证的接口,请在请求头中携带 API Key:
Authorization: Bearer sk-xxxx
| 环境 | 地址 |
|---|---|
| 生产 | https://your-domain.com |
| 测试 | 与生产相同,使用不同的 API Key 区分 |
| 错误码 | 含义 | 说明 |
|---|---|---|
| 0 | 成功 | 请求处理成功 |
| 40001 | 参数错误 | 缺少必填参数或参数格式不正确 |
| 40101 | 未认证 | 未提供有效的 Authorization 头 |
| 40301 | 权限不足 | 无权访问该资源 |
| 40401 | 资源不存在 | 请求的用户、Key 等资源不存在 |
| 42901 | 请求频率超限 | 请降低调用频率后重试 |
| 50001 | 服务器内部错误 | 请稍后重试或联系管理员 |