本项目为对 chenyme/grok2api 的二次修改与增强。

中文 | English

基于 FastAPI 重构的 Grok2API，全面适配最新 Web 调用格式，支持流/非流式对话、图像生成/编辑、深度思考，号池并发与自动负载均衡一体化。

本仓库额外提供 Cloudflare Workers / Pages（TypeScript，D1 + KV）版本，适合在 Cloudflare 上运行与代理出站。

• 部署与配置说明：README.cloudflare.md
• 一键部署工作流：.github/workflows/cloudflare-workers.yml

• 本地开发

uv sync

uv run main.py

# （可选）启动后自检
python scripts/smoke_test.py --base-url http://127.0.0.1:8000

• 项目部署

git clone https://github.com/TQZHR/grok2api.git

# 进入项目目录
cd grok2api

# 直接拉取镜像启动（默认）
docker compose up -d

# 更新到最新镜像
docker compose pull
docker compose up -d

# 从当前仓库源码构建并启动（可选）
docker compose -f docker-compose.yml -f docker-compose.build.yml up -d --build

# （可选）启动后自检
python scripts/smoke_test.py --base-url http://127.0.0.1:8000

如果拉取镜像时报 denied：说明 GHCR 镜像不可匿名拉取（未公开或需要登录）。你可以先执行 docker login ghcr.io，或在 .env 里设置 GROK2API_IMAGE 指向你自己的公开镜像；也可以用上面的 --build 从源码构建运行。

可选：复制 .env.example 为 .env，可配置端口/日志/存储等；并可通过 COMPOSE_PROFILES 一键启用 redis/pgsql/mysql（见 .env.example 内示例）。

访问地址：http://<host>:8000/login

默认账号密码：admin / admin（对应配置项 app.admin_username / app.app_key，建议上线后修改）。

常用页面：

• http://<host>:8000/admin/token：Token 管理（导入/导出/批量操作/自动注册）
• http://<host>:8000/admin/datacenter：数据中心（常用指标 + 日志查看）
• http://<host>:8000/admin/config：配置管理（含自动注册所需配置）
• http://<host>:8000/admin/cache：缓存管理（本地缓存 + 在线资产）

支持两种方式：

• 直接添加 Token（手动/批量导入）
• 自动注册并自动写入 Token 池

自动注册特性：

• 可设置注册数量（不填默认 100）
• 可设置并发（默认 10）
• 注册前会自动启动本地 Turnstile Solver（默认 5 线程），注册结束后自动关闭
• 注册成功后会自动执行：同意用户协议（TOS）+ 开启 NSFW
  • 若协议未成功同意或 NSFW 未成功开启，会判定该次注册失败并在前端显示错误原因

自动注册前置配置（在「配置管理」-> register.*）：

• register.worker_domain / register.email_domain / register.admin_password：临时邮箱 Worker 配置
• register.solver_url / register.solver_browser_type / register.solver_threads：本地 Turnstile Solver 配置
• 可选：register.yescaptcha_key（配置后优先走 YesCaptcha，无需本地 solver）

升级兼容：

• 本地部署升级后会自动对「旧 Token」做一次 TOS + NSFW（并发 10，best-effort，仅执行一次，避免重复刷）。

配置 .env 文件

• 配置文件：data/config.toml（首次启动会基于 config.defaults.toml 自动生成；管理面板也可直接修改）
• Token 数据：data/token.json
• 升级时自动兼容迁移（本地/Docker）：
  • 旧版配置：检测到 data/setting.toml 时，会按“缺失字段/仍为默认值”的策略合并到新配置
  • 旧版缓存目录：data/temp/{image,video} -> data/tmp/{image,video}
  • 旧账号一次性修复（best-effort）：升级后会对现有 Token 自动执行一次「同意用户协议 + 开启 NSFW」（并发 10）

• Basic 账号：80 次 / 20h
• Super 账号：无账号，作者未测试

通用接口，支持对话聊天、图像生成、图像编辑、视频生成、视频超分

curl http://localhost:8000/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $GROK2API_API_KEY" \
  -d '{
    "model": "grok-4",
    "messages": [{"role":"user","content":"你好"}]
  }'

图像接口，支持图像生成、图像编辑

curl http://localhost:8000/v1/images/generations \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $GROK2API_API_KEY" \
  -d '{
    "model": "grok-imagine-1.0",
    "prompt": "一只在太空漂浮的猫",
    "n": 1
  }'

配置文件：data/config.toml

当你从旧版本升级到当前版本时，程序会在启动时自动兼容并读取旧数据：

• 旧配置：若存在 data/setting.toml，会自动迁移/合并到 data/config.toml（仅覆盖“缺失项”或“仍为默认值”的字段）。
• 旧缓存目录：旧版 data/temp/{image,video} 会自动迁移到新版 data/tmp/{image,video}，未到清理时间的缓存文件不会丢失。
• Docker 部署：务必持久化挂载 ./data:/app/data（以及 ./logs:/app/logs），否则容器更新/重建会丢失本地数据。