API 参考
介绍
网关 API 总览:地址、鉴权、协议与错误
AICoderBox 网关暴露两套互相独立又共用一个 Key/余额池的协议:OpenAI 兼容的 /v1/chat/completions 和 Anthropic 兼容的 /v1/messages。你按模型属于哪一家,选对应端点即可。
Base URL
text
https://coder.aicoderbox.com鉴权
每个请求都要带 API Key,两种 header 写法都收:
http
Authorization: Bearer sk-acb-xxxx
# 或
x-api-key: sk-acb-xxxx两个端点
| 端点 | 协议 | 适合 |
|---|---|---|
POST /v1/chat/completions | OpenAI 兼容 | GPT 系、xAI、以及各家自营对话模型 |
POST /v1/messages | Anthropic 兼容 | Claude 系模型 |
错误响应
所有错误都是统一结构:HTTP 状态码 + JSON body {"detail": "..."}。常见几种:
| 状态码 | 含义 | detail 示例 |
|---|---|---|
| 401 | Key 无效或缺失 | 无效的 API Key |
| 402 | 余额池积分不足 | 积分不足 |
| 404 | 模型名不存在 | 模型不存在 |
| 502 | 上游异常(本次已退款) | 上游服务暂时不可用 |
计费与退款: 每次成功调用按模型「积分/次」扣费并写入调用日志;上游失败时本次积分自动退回,日志状态记为
refunded。扣费顺序永远是先订阅积分后加油包积分。先跑 Mock 联调: 本地/演示环境开启
MOCK_UPSTREAM=1 时,网关不打真实上游,直接返回一段固定的演示响应——用来验证鉴权、扣费、退款链路,不消耗真实上游额度。关于流式
当前版本按非流式返回,请把 stream 设为 false(或省略)。完整的 SSE 流式会在后续版本开放。