chenyme / grok2api

A multi-account API gateway for Grok Build, Grok Web, and Grok Console. 这是一个用于 Grok Build、Grok Web 和 Grok Console 的多账号 API 网关。

Tip

Check out DEEIX-AI / DEEIX-Chat, a lightweight, integrated AI platform for model routing, chat, files, tools, billing, identity, and operations. 查看 DEEIX-AI / DEEIX-Chat，这是一个轻量级、集成的 AI 平台，支持模型路由、聊天、文件、工具、计费、身份验证和运维管理。

Note

This project is for technical research and learning purposes only. Please comply with Grok’s official terms of use and local laws when using it; otherwise, you will be solely responsible for all consequences! 本项目仅供技术研究和学习使用。使用时请遵守 Grok 的官方使用条款及当地法律法规；否则，由此产生的一切后果由您自行承担！

Overview

Grok2API is a Go gateway with a built-in React admin console. It manages independent Grok Build, Grok Web, and Grok Console account pools and exposes unified OpenAI- and Anthropic-compatible APIs. Grok2API 是一个使用 Go 语言编写的网关，内置 React 管理控制台。它管理独立的 Grok Build、Grok Web 和 Grok Console 账号池，并对外提供统一的 OpenAI 和 Anthropic 兼容 API。

Loading

The Gateway routes requests through the Provider Registry. Account Sync refreshes credentials, quota, and models. Each Provider keeps independent account state and uses an isolated egress scope; usage, audits, and client billing are finalized after the request. 网关通过提供商注册中心（Provider Registry）路由请求。账号同步（Account Sync）负责刷新凭据、配额和模型。每个提供商保持独立的账号状态并使用隔离的出站范围；使用情况、审计和客户计费在请求完成后结算。

Core capabilities

Area	Capabilities
APIs	Responses, Chat Completions, Anthropic Messages, Images, and asynchronous Videos
Clients	Codex, Claude Code, OpenAI-compatible SDKs, and Anthropic-compatible SDKs
Accounts	Bulk import/export, quota sync, credential renewal, conversion, tools, and cleanup
Routing	Model discovery, Provider pinning, sticky sessions, quota/concurrency guards, and bounded failover
Sessions	Stored responses, compact, prompt-cache affinity, and optional reasoning replay
Media	Image generation/editing, video jobs, local archiving, and URL/Base64/SSE output
Egress	HTTP/SOCKS/Resin, subscriptions, probes, proxy pools, allocation, fallback, and FlareSolverr
Operations	Dashboard, model routes, client keys, audits, runtime settings, and media libraries

核心功能

领域	功能
API	响应、聊天补全、Anthropic 消息、图像及异步视频
客户端	Codex、Claude Code、OpenAI 兼容 SDK 及 Anthropic 兼容 SDK
账号	批量导入/导出、配额同步、凭据更新、转换、工具及清理
路由	模型发现、提供商绑定、会话保持、配额/并发保护及有限故障转移
会话	存储响应、压缩、提示词缓存亲和性及可选的推理重放
媒体	图像生成/编辑、视频任务、本地归档及 URL/Base64/SSE 输出
出站	HTTP/SOCKS/Resin、订阅、探测、代理池、分配、故障转移及 FlareSolverr
运维	仪表盘、模型路由、客户端密钥、审计、运行时设置及媒体库

Provider boundaries

Provider	Authentication	Models	Main capabilities
Grok Build	OAuth / Device OAuth	Discovered per account	Responses, Chat, Messages, compact, stored responses, paid-account video
Grok Web	SSO	Built-in, filtered by tier	Responses, Chat, Messages, stored responses, images, image editing, video
Grok Console	SSO	Built-in Stateless	Responses, Chat, Messages, images, image editing, video

提供商边界

提供商	认证方式	模型	主要功能
Grok Build	OAuth / 设备 OAuth	按账号发现	响应、聊天、消息、压缩、存储响应、付费账号视频
Grok Web	SSO	内置，按等级过滤	响应、聊天、消息、存储响应、图像、图像编辑、视频
Grok Console	SSO	内置无状态	响应、聊天、消息、图像、图像编辑、视频

Each Provider keeps its own credentials, quota, health, cooldown, concurrency, and model capabilities. Failover stays within the selected Provider. 每个提供商维护各自的凭据、配额、健康状态、冷却时间、并发限制和模型能力。故障转移仅在所选提供商内部进行。

Quick start

Official images support linux/amd64 and linux/arm64. 官方镜像支持 linux/amd64 和 linux/arm64。

git clone https://github.com/chenyme/grok2api.git
cd grok2api
cp config.example.yaml config.yaml

Generate secrets and place them in config.yaml: 生成密钥并将其放入 config.yaml：

openssl rand -hex 32
openssl rand -base64 32

secrets:

jwtSecret: "replace-with-the-generated-hex-value"
credentialEncryptionKey: "replace-with-the-generated-base64-key"