公开文档
双协议 API 接入指南
KeyPool 网关同时兼容 OpenAI 与 Anthropic 原生协议。DeepSeek、智谱、Kimi、通义、豆包、MiMo、硅基流动等国产平台走 OpenAI 兼容路径,按 model 前缀自动路由到对应上游。使用控制台创建的 虚拟 Key(形如 sk-kp-…)作为凭据,将客户端 base URL 指向网关即可。
网关地址
当前公开网关来自环境变量 GATEWAY_PUBLIC_URL:
http://localhost:8080
- OpenAI base URL:
http://localhost:8080/v1 - Anthropic base URL:
http://localhost:8080(路径含/v1/messages) - 健康检查:
GET http://localhost:8080/healthz
认证
OpenAI 风格
请求头 Authorization: Bearer sk-kp-…
Anthropic 风格
请求头 x-api-key: sk-kp-…,并附带 anthropic-version
完整虚拟 Key 仅在创建或轮换时展示一次。请在 控制台 → 虚拟 Key 中管理。调用会按用量从对应平台信用账户扣费。
临时协议转换会话(免登录)
首页「协议转换」可在未登录时签发临时 Token(sk-kp-tmp-…),TTL 15/30/60 分钟,有 IP 与会话次数限流。你的上游 Key 经 AES-GCM 加密写入 Redis,不落库、不与社区积分 / 虚拟 Key 扣费混用。网关识别临时 Token 后转发至协议转换引擎(AxonHub),仅支持 chat completions 与 messages。
- 签发:
POST /api/public/convert-session - 试聊(同源 BFF):
POST /api/public/convert-session/chat - 销毁:
DELETE /api/public/convert-session(body 含 token)
# 1) 签发(在 Web 源站,勿把上游 Key 写进公开仓库)
curl -sS -X POST /api/public/convert-session \
-H "content-type: application/json" \
-d '{"apiKey":"你的上游Key","clientProtocol":"openai","model":"deepseek-chat","ttlSec":900}'
# 2) 用返回的 sk-kp-tmp-… 调网关
curl http://localhost:8080/v1/chat/completions \
-H "Authorization: Bearer sk-kp-tmp-…" \
-H "Content-Type: application/json" \
-d '{"model":"deepseek-chat","messages":[{"role":"user","content":"ping"}],"max_tokens":32}'长期社区共享与积分赎回请使用控制台虚拟 Key(sk-kp-…,非 tmp)。资源市场挂单仅展示脱敏额度,消费需登录赎回。
OpenAI · Chat Completions
POST http://localhost:8080/v1/chat/completions兼容 OpenAI Chat Completions。将 OPENAI_BASE_URL 指向 网关 /v1,OPENAI_API_KEY 填虚拟 Key。
# 环境变量
export OPENAI_BASE_URL="http://localhost:8080/v1"
export OPENAI_API_KEY="sk-kp-你的虚拟Key"
# curl 示例
curl http://localhost:8080/v1/chat/completions \
-H "Authorization: Bearer sk-kp-你的虚拟Key" \
-H "Content-Type: application/json" \
-d '{
"model": "gpt-4o-mini",
"messages": [
{"role": "user", "content": "你好,介绍一下 KeyPool"}
]
}'Anthropic · Messages
POST http://localhost:8080/v1/messages兼容 Anthropic Messages API。将 ANTHROPIC_BASE_URL 指向 网关根地址,使用虚拟 Key 作为 x-api-key。
# 环境变量
export ANTHROPIC_BASE_URL="http://localhost:8080"
export ANTHROPIC_API_KEY="sk-kp-你的虚拟Key"
# curl 示例
curl http://localhost:8080/v1/messages \
-H "x-api-key: sk-kp-你的虚拟Key" \
-H "anthropic-version: 2023-06-01" \
-H "Content-Type: application/json" \
-d '{
"model": "claude-3-5-haiku-latest",
"max_tokens": 256,
"messages": [
{"role": "user", "content": "你好,介绍一下 KeyPool"}
]
}'风险与责任声明
- 向共享池贡献上游 API Key 可能违反部分供应商服务条款(ToS)。你须自行确认并承担全部合规责任。
- KeyPool 仅提供加密托管、计量与路由;不豁免你对上游账户、账单与滥用行为的义务。
- 请勿在日志、截图或公开渠道泄露完整上游 Key 或虚拟 Key。