# xLyra

> 开源、自托管的多站点 AI 网关与控制平面（OpenAI / Anthropic 兼容）。

xLyra is an open-source, self-hosted LLM API gateway and control plane with OpenAI- and Anthropic-compatible endpoints, smart routing, and Docker deployment.

## Canonical
- Website: https://xlyra.yachiyo.im
- Full summary: https://xlyra.yachiyo.im/llms-full.txt
- Source code: https://github.com/Yachiyo-5i/xLyra
- Container image: https://hub.docker.com/r/yachiiiiyo/xlyra (yachiiiiyo/xlyra)
- License: AGPL-3.0 — https://github.com/Yachiyo-5i/xLyra/blob/main/LICENSE

## When to use
- 你需要一个统一入口连接多家官方 API、OAuth 订阅账号或上游站点。
- 你想在应用侧只维护一个 base URL 与下游 API Key。
- 你需要路由、协议互转、故障切换、成本估算与可自托管的数据平面。

## Capabilities
- 18 upstream site / account types
- 9+ gateway HTTP endpoints
- Text protocols (any-to-any): Chat Completions, Responses API, Anthropic Messages, Gemini
- Console: 流量拓扑图, 成本估算, 用量分账, Playground, S3 兼容备份, TOTP, 审计日志
- Stack: Go, React, PostgreSQL; deploy via Docker / Docker Compose

## Deploy
1. Use Docker Compose (see https://xlyra.yachiyo.im/#quick-start or https://github.com/Yachiyo-5i/xLyra/blob/main/docker-compose.yml).
2. Open console on port 5801, create admin user, add sites.
3. Point OpenAI or Anthropic SDK base URL to xLyra; use a downstream API key from the console.

## FAQ
Q: xLyra 是什么？
A: xLyra 是开源的 AI 网关与控制平面。它位于你的应用与各家 AI 上游之间，向应用提供统一的 OpenAI / Anthropic 兼容接口，并负责路由、协议转换、限流、成本估算和故障转移。

Q: 接入 xLyra 需要改代码吗？
A: 通常不需要。把现有 OpenAI 或 Anthropic SDK 的 base URL 指向 xLyra，并换用在控制台颁发的下游 API Key 即可。

Q: xLyra 支持哪些上游？
A: 当前提供 18 种接入类型：OpenAI、Anthropic Claude、Google Gemini、OpenCode Go、DeepSeek、MiniMax、Xiaomi MiMo、Moonshot、Kimi Code、GLM、GLM Code、TypeSafe；Grok 通过 xAI 设备授权接入；NewAPI 与 xLyra 可作为级联或聚合站点；另支持 Codex OAuth、Antigravity OAuth 和 Claude Code OAuth 账号。

Q: 上游出错时，请求会自动切换吗？
A: 会。路由引擎综合健康度、延迟、价格、冷却状态和优先级为每个上游评分，失败后自动切换到下一个。切换只在首个字节写出之前进行；流式响应一旦开始，就不会再更换上游。

Q: 我的数据保存在哪里？
A: xLyra 由你自行部署。站点凭据、请求日志和用量数据保存在你自己的 PostgreSQL 中，并支持 S3 兼容备份。

Q: 如何部署 xLyra？
A: 使用 Docker Compose 启动 xLyra 与 PostgreSQL，然后打开控制台创建管理员账号。公开部署前，请修改数据库密码，并配置 HTTPS、反向代理与访问控制。

Q: 为什么不直接调用每家模型 API？
A: 直接调用意味着分别维护协议、密钥、限流、故障处理和账单。xLyra 把这些集中到一个网关：应用只需要认识一个地址，其余交给控制面。

Q: xLyra 使用什么开源许可？
A: xLyra 以 AGPL-3.0 许可开源，源码托管在 GitHub。