# FOXNIO — 完整文档

> 智能 AI API 代理服务，支持 Anthropic 与 OpenAI 兼容格式，提供 Token 池管理、流式响应与分组路由。

## 产品概述

FOXNIO 是一个自托管的 AI API 代理网关。它接收标准的 Anthropic Messages API 或 OpenAI Responses API 请求，通过内部 Token 池管理和路由策略，将请求转发到后端 AI 模型服务，并将响应转换回对应的 API 格式返回给客户端。

### 适用场景

- 企业内部统一 AI API 入口
- 多模型 Token 池化管理与负载均衡
- 用户级别的额度控制与计费
- API Key 分发与权限管理

## 核心功能

### 1. 双 API 兼容
- **Anthropic Messages API**: `POST /v1/messages` — 完整支持 messages 格式、system prompt、tool use、streaming
- **OpenAI Responses API**: `POST /v1/responses` — 自动转换为内部格式处理
- **分组路由**: `POST /:group/v1/messages` — 按等级路由到不同 Token 池

### 2. Token 池管理
- 多 Token 轮询与负载均衡
- 自动故障转移：Token 失败自动切换
- 冷却机制：异常 Token 自动冷却，恢复后重新加入
- 实时状态监控：可用/冷却/耗尽状态可视化

### 3. 流式响应
- 完整 SSE (Server-Sent Events) 流式输出
- 支持 Anthropic 原生事件流格式
- thinking/reasoning 内容流式传输

### 4. 用户与权限
- 用户注册与认证（JWT）
- 多等级体系（Tier）：不同等级对应不同模型访问权限和速率限制
- API Key 管理：用户可创建多个 Key，支持分组权限
- 额度管理：总额度 + 每日额度双重控制

### 5. 计费系统
- 按 Token 用量计费
- 套餐（Plan）订阅
- 订单管理与交易记录
- 余额充值与退款

### 6. 邀请码系统
- **审核模式**: 用户提交申请，管理员审批
- **付费模式**: 用户付费后自动获得邀请码
- **守门员模式**: AI 砍价机器人，用户通过对话协商价格

### 7. 管理后台
- 仪表盘：请求量、Token 用量、用户活跃度等实时统计
- Token 池管理：添加/删除/监控 Token 状态
- 用户管理：搜索、筛选、额度调整、封禁
- 请求日志：完整的请求/响应日志查询
- 系统设置：动态配置模型映射、速率限制等

## 技术架构

- **后端**: Go (Gin framework), PostgreSQL, Redis
- **前端**: Vue 3, TypeScript, Tailwind CSS
- **部署**: Docker, Docker Compose
- **认证**: JWT + API Key

## API 认证

所有 API 请求需要在 Header 中携带认证信息：

```
Authorization: Bearer <your-api-key>
```

或使用 Anthropic 格式：

```
x-api-key: <your-api-key>
```

## 常见问题

### FOXNIO 是什么？
FOXNIO 是一个自托管的 AI API 代理网关，帮助团队统一管理 AI 模型访问、控制成本和分配权限。

### 支持哪些 AI 模型？
通过 Token 池配置，可以接入多种 AI 模型服务。系统自动处理请求格式转换。

### 如何获取访问权限？
可以通过注册账号、管理员邀请、或邀请码申请（审核/付费/守门员模式）获取。

### 是否支持流式输出？
完整支持 SSE 流式输出，兼容 Anthropic 和 OpenAI 的流式响应格式。

### 如何部署？
支持 Docker 一键部署，提供 docker-compose 配置，内置 PostgreSQL 和 Redis。

## 联系

- 登录: /login
- 注册: /register
- 申请邀请码: /invite-apply