Appearance
API 接口清单
认证
同一个 sk- 令牌(控制台"令牌"页创建),按接口风格选认证方式:
| 风格 | 认证方式 |
|---|---|
OpenAI 兼容(/v1/*) | Authorization: Bearer sk-xxx |
Claude 原生(/v1/messages) | x-api-key: sk-xxx + anthropic-version: 2023-06-01 |
Gemini 原生(/v1beta/*) | x-goog-api-key: sk-xxx 或 ?key=sk-xxx |
接口
对话(OpenAI 兼容)
| 方法 | 路径 | 说明 |
|---|---|---|
| POST | /v1/chat/completions | 对话补全,支持 stream: true |
| POST | /v1/completions | 传统文本补全 |
| POST | /v1/responses | OpenAI Responses API |
Claude 原生
| 方法 | 路径 | 说明 |
|---|---|---|
| POST | /v1/messages | Claude Messages API,支持流式 |
Gemini 原生
| 方法 | 路径 | 说明 |
|---|---|---|
| POST | /v1beta/models/{model}:generateContent | 生成内容 |
| POST | /v1beta/models/{model}:streamGenerateContent | 流式生成 |
向量 / 重排 / 图像
| 方法 | 路径 | 说明 |
|---|---|---|
| POST | /v1/embeddings | 文本向量 |
| POST | /v1/rerank | 重排 |
| POST | /v1/images/generations | 文生图 |
| POST | /v1/images/edits | 图像编辑 |
模型与额度查询
| 方法 | 路径 | 说明 |
|---|---|---|
| GET | /v1/models | 可用模型列表(按认证头自动返回对应格式) |
| GET | /v1/dashboard/billing/subscription | 令牌额度上限 |
| GET | /v1/dashboard/billing/usage | 已用金额(美元 ×100) |
| GET | /api/status | 站点状态(免认证,可作健康检查) |
错误码
错误响应为 OpenAI 风格:
json
{ "error": { "message": "错误描述", "type": "new_api_error", "code": "invalid_api_key" } }| HTTP | 原因 | 处理 |
|---|---|---|
| 400 | 请求参数错误 | 对照对应格式官方文档检查 |
| 401 | 令牌无效或已禁用 | 检查认证头与令牌状态 |
| 403 | 额度不足、模型无权限 | 充值或检查令牌限制 |
| 429 | 触发限流 | 降频重试 |
| 5xx | 上游异常 | 可重试,持续失败请联系客服 |
示例
bash
# OpenAI 对话
curl https://your-domain.com/v1/chat/completions \
-H "Authorization: Bearer sk-xxx" -H "Content-Type: application/json" \
-d '{"model":"gpt-4o","messages":[{"role":"user","content":"Hello"}]}'
# Claude 原生
curl https://your-domain.com/v1/messages \
-H "x-api-key: sk-xxx" -H "anthropic-version: 2023-06-01" -H "Content-Type: application/json" \
-d '{"model":"claude-sonnet-4-5","max_tokens":1024,"messages":[{"role":"user","content":"Hello"}]}'
# Gemini 原生
curl "https://your-domain.com/v1beta/models/gemini-2.5-pro:generateContent?key=sk-xxx" \
-H "Content-Type: application/json" \
-d '{"contents":[{"parts":[{"text":"Hello"}]}]}'
# 查询额度
curl https://your-domain.com/v1/dashboard/billing/subscription \
-H "Authorization: Bearer sk-xxx"