logo
0
0
WeChat Login
Chenyme<118253778+chenyme@users.noreply.github.com>
fix: update authentication and configuration documentation

Grok2API

中文 | English

NOTE

本项目仅供学习与研究,使用者必须在遵循 Grok 的 使用条款 以及 法律法规 的情况下使用,不得用于非法用途。

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

image

使用说明

如何启动

  • 本地开发
uv sync uv run main.py
  • 项目部署
git clone https://github.com/chenyme/grok2api docker compose up -d

管理面板

访问地址:http://<host>:8000/admin 默认登录密码:grok2api(对应配置项 app.app_key,建议修改)。

功能说明

  • Token 管理:导入/添加/删除 Token,查看状态和配额
  • 状态筛选:按状态(正常/限流/失效)或 NSFW 状态筛选
  • 批量操作:批量刷新、导出、删除、开启 NSFW
  • NSFW 开启:一键为 Token 开启 Unhinged 模式(需代理或 cf_clearance)
  • 配置管理:在线修改系统配置
  • 缓存管理:查看和清理媒体缓存

环境变量

配置 .env 文件

变量名说明默认值示例
LOG_LEVEL日志级别INFODEBUG
SERVER_HOST服务监听地址0.0.0.00.0.0.0
SERVER_PORT服务端口80008000
SERVER_WORKERSUvicorn worker 数量12
SERVER_STORAGE_TYPE存储类型(local/redis/mysql/pgsqllocalpgsql
SERVER_STORAGE_URL存储连接串(local 时可为空)""postgresql+asyncpg://user:password@host:5432/db

MySQL 示例:mysql+aiomysql://user:password@host:3306/db(若填 mysql:// 会自动转为 mysql+aiomysql://

MySQL 示例:mysql+aiomysql://user:password@host:3306/db(若填 mysql:// 会自动转为 mysql+aiomysql://

可用次数

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

可用模型

模型名计次可用账号对话功能图像功能视频功能
grok-31Basic/Super支持支持-
grok-3-fast1Basic/Super支持支持-
grok-41Basic/Super支持支持-
grok-4-mini1Basic/Super支持支持-
grok-4-fast1Basic/Super支持支持-
grok-4-heavy4Super支持支持-
grok-4.11Basic/Super支持支持-
grok-4.1-thinking4Basic/Super支持支持-
grok-imagine-1.04Basic/Super-支持-
grok-imagine-1.0-video-Basic/Super--支持

接口说明

POST /v1/chat/completions

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

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":"你好"}] }'
支持的请求参数
字段类型说明可用参数
modelstring模型名称见上方模型列表
messagesarray消息列表见下方消息格式
streamboolean是否开启流式输出true, false
thinkingstring思维链模式enabled, disabled, null
video_configobject视频模型专用配置对象-
└─aspect_ratiostring视频宽高比16:9, 9:16, 1:1, 2:3, 3:2
└─video_lengthinteger视频时长 (秒)6, 10
└─resolution_namestring分辨率480p, 720p
└─presetstring风格预设fun, normal, spicy, custom

消息格式 (messages)

字段类型说明
rolestring角色:developer, system, user, assistant
contentstring/array消息内容,支持纯文本或多模态数组

多模态内容块类型 (content array)

type说明示例
text文本内容{"type": "text", "text": "描述这张图片"}
image_url图片 URL{"type": "image_url", "image_url": {"url": "https://..."}}
file文件{"type": "file", "file": {"url": "https://..."}}

注:除上述外的其他参数将自动丢弃并忽略


POST /v1/images/generations

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

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 }'
支持的请求参数
字段类型说明可用参数
modelstring图像模型名grok-imagine-1.0
promptstring图像描述提示词-
ninteger生成数量1 - 10 (流式模式仅限 12)
streamboolean是否开启流式输出true, false
sizestring图片尺寸1024x1024 (暂不支持自定义)
qualitystring图片质量standard (暂不支持自定义)
response_formatstring响应格式url, b64_json
stylestring风格- (暂不支持)

注:sizequalitystyle 参数为 OpenAI 兼容保留,当前版本暂不支持自定义



参数配置

配置文件:data/config.toml

NOTE

生产环境或反向代理部署时,请确保 app.app_url 配置为对外可访问的完整 URL, 否则可能出现文件访问链接不正确或 403 等问题。

模块字段配置名说明默认值
appapp_url应用地址当前 Grok2API 服务的外部访问 URL,用于文件链接访问。http://127.0.0.1:8000
app_key后台密码登录 Grok2API 管理后台的密码(必填)。grok2api
api_keyAPI 密钥调用 Grok2API 服务的 Token(可选)。""
image_format图片格式生成的图片格式(url 或 base64)。url
video_format视频格式生成的视频格式(html 或 url,url 为处理后的链接)。html
groktemporary临时对话是否启用临时对话模式。true
stream流式响应是否默认启用流式输出。true
thinking思维链是否启用模型思维链输出。true
dynamic_statsig动态指纹是否启用动态生成 Statsig 值。true
filter_tags过滤标签自动过滤 Grok 响应中的特殊标签。["xaiartifact", "xai:tool_usage_card", "grok:render"]
timeout超时时间请求 Grok 服务的超时时间(秒)。120
base_proxy_url基础代理 URL代理请求到 Grok 官网的基础服务地址。""
asset_proxy_url资源代理 URL代理请求到 Grok 官网的静态资源(图片/视频)地址。""
cf_clearanceCF ClearanceCloudflare 验证 Cookie,用于验证 Cloudflare 的验证。""
max_retry最大重试请求 Grok 服务失败时的最大重试次数。3
retry_status_codes重试状态码触发重试的 HTTP 状态码列表。[401, 429, 403]
retry_backoff_base退避基数重试退避的基础延迟(秒)。0.5
retry_backoff_factor退避倍率重试退避的指数放大系数。2.0
retry_backoff_max退避上限单次重试等待的最大延迟(秒)。30.0
retry_budget退避预算单次请求的最大重试总耗时(秒)。90.0
stream_idle_timeout流空闲超时流式响应空闲超时(秒),超过将断开。45.0
video_idle_timeout视频空闲超时视频生成空闲超时(秒),超过将断开。90.0
tokenauto_refresh自动刷新是否开启 Token 自动刷新机制。true
refresh_interval_hours刷新间隔Token 刷新的时间间隔(小时)。8
fail_threshold失败阈值单个 Token 连续失败多少次后被标记为不可用。5
save_delay_ms保存延迟Token 变更合并写入的延迟(毫秒)。500
reload_interval_sec一致性刷新多 worker 场景下 Token 状态刷新间隔(秒)。30
cacheenable_auto_clean自动清理是否启用缓存自动清理,开启后按上限自动回收。true
limit_mb清理阈值缓存大小阈值(MB),超过阈值会触发清理。1024
performancensfw_max_concurrent开启 NSFW 模式并发上限批量开启 NSFW 模式时的并发请求上限。推荐 10。10
nsfw_batch_size开启 NSFW 模式批次大小批量开启 NSFW 模式的单批处理数量。推荐 50。50
nsfw_max_tokens开启 NSFW 模式最大数量单次批量开启 NSFW 的 Token 数量上限,防止误操作。推荐 1000。1000
usage_max_concurrentToken 用量刷新并发上限批量刷新 Token 用量时的并发请求上限。推荐 25。25
usage_batch_sizeToken 用量刷新批次大小批量刷新 Token 用量的单批处理数量。推荐 50。50
usage_max_tokensToken 用量刷新最大数量批量刷新 Token 用量的单次处理数量上限。推荐 1000。1000
assets_max_concurrent在线资产查找/删除并发上限在线资产查找/删除时的并发请求上限。推荐 25。25
assets_batch_size在线资产查找/删除批次大小在线资产查找/删除的单批处理数量。推荐 10。10
assets_max_tokens在线资产查找/删除最大数量在线资产查找/删除的单次处理数量上限。推荐 1000。1000
assets_delete_batch_size在线资产删除批量在线资产删除单批并发数量。推荐 10。10
media_max_concurrent媒体并发上限视频/媒体生成请求的并发上限。推荐 50。50

Star History

Star History Chart