环境变量#

修改 .env 或 docker-compose.yml 文件生效

部署方式#

1
git clone https://github.com/chenyme/grok2api
2

3
uv sync
4

5
uv run granian --interface asgi main:app

1
git clone https://github.com/chenyme/grok2api
2

3
cd grok2api
4

5
docker compose up -d

1
services:
2
  grok2api:
3
    container_name: grok2api
4
    image: ghcr.io/chenyme/grok2api:latest
5
    ports:
6
      - "${HOST_PORT:-8000}:${SERVER_PORT:-8000}"
7
    environment:
8
      TZ: Asia/Shanghai
9
      LOG_LEVEL: ${LOG_LEVEL:-INFO}
10
      SERVER_HOST: ${SERVER_HOST:-0.0.0.0}
11
      SERVER_PORT: ${SERVER_PORT:-8000}
12
      SERVER_WORKERS: ${SERVER_WORKERS:-1}
13
      SERVER_STORAGE_TYPE: ${SERVER_STORAGE_TYPE:-local}
14
      SERVER_STORAGE_URL: ${SERVER_STORAGE_URL:-}
15
      # 启用 CF 自动刷新: 取消以下三行注释，并取消底部 flaresolverr 服务的注释
16
      # FLARESOLVERR_URL: http://flaresolverr:8191
17
      # CF_REFRESH_INTERVAL: "600"
18
      # CF_TIMEOUT: "60"
19

20
      # SERVER_STORAGE_TYPE: (local, redis, mysql, pgsql) default: local
21
      # SERVER_STORAGE_URL: (local mode is empty) default: empty
22
      #   Redis: redis://localhost:6379/0 or redis://:password@localhost:6379/0
23
      #   MySQL: mysql+aiomysql://user:pass@localhost/db
24
      #   PgSQL: postgresql+asyncpg://user:pass@localhost/db
25
    command:
26
      - sh
27
      - -c
28
      - >
29
        granian --interface asgi --host "$${SERVER_HOST:-0.0.0.0}"
30
        --port "$${SERVER_PORT:-8000}" --workers "$${SERVER_WORKERS:-1}" main:app
31
    volumes:
32
      - ./data:/app/data
33
      - ./logs:/app/logs
34
    restart: unless-stopped
35

36
  # 如果出口 IP 不干净，可取消以下注释使用 Warp 作为落地代理
37
  # 启用后将 proxy.base_proxy_url 设为 socks5://warp:1080
38
  # warp:
39
  #   container_name: warp
40
  #   image: caomingjun/warp:latest
41
  #   restart: unless-stopped
42
  #   ports:
43
  #     - "127.0.0.1:1080:1080"
44
  #   environment:
45
  #     - WARP_SLEEP=2
46
  #   cap_add:
47
  #     - NET_ADMIN
48

49
  # 启用 CF 自动刷新时取消以下注释
50
  # flaresolverr:
51
  #   container_name: flaresolverr
52
  #   image: ghcr.io/flaresolverr/flaresolverr:latest
53
  #   ports:
54
  #     - "127.0.0.1:8191:8191"
55
  #   environment:
56
  #     TZ: Asia/Shanghai
57
  #     LOG_LEVEL: info
58
  #   restart: unless-stopped

基础信息#

1. 访问地址

   • 管理后台：http://<host>:8000/admin

   • 功能玩法：http://<host>:8000/（管理后台开启后生效）

   • 默认密码：grok2api

2. 账号配额 Grok 官方网页更新后并未真实暴露 rate-limits 接口，导致无法准确计算 Token 剩余，请耐心等待官方接口上线，目前自动刷新后会统一更新为剩余 8 次。

   • Basic 账号：80 次 / 20h

   • Super 账号：140 次 / 2h

模型支持#

1. POST /v1/chat/completions#

OpenAI Chat Completions API 通用接口，支持聊天对话、图像生成、图像编辑、视频生成。

调用示例（curl）

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

支持的请求参数

消息格式 (messages)

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

注意事项

1. image_url/input_audio/file 仅支持 URL 或 Data URI（data:<mime>;base64,...），裸 base64 会报错。

2. reasoning_effort：none 表示不输出思考，其他值都会输出思考内容。

3. 工具调用为提示词模拟 + 客户端执行回填：模型通过 <tool_call>{...}</tool_call> 输出调用请求，服务端解析为 tool_calls；不执行工具。

4. grok-imagine-1.0-fast 与瀑布流 imagine 生成链路一致，可直接通过 /v1/chat/completions 调用；其 n/size/response_format 由服务端 [imagine_fast] 统一控制。

5. 在 /v1/chat/completions 的流式输出仅返回最终成图，不返回中间预览图；流式 URL 出图会保持原始图片名（不追加 -final 后缀）。

6. grok-imagine-1.0-edit 必须提供图片，多图默认取最后 3 张与最后一个文本。

7. grok-imagine-1.0-video 支持文生视频与图生视频（通过 image_url 传参考图，仅取第 1 张）。

8. 当图片疑似被审查拦截导致无最终图时，若开启 image.blocked_parallel_enabled，服务端会按 image.blocked_parallel_attempts 自动并行补偿生成，并优先使用不同 token；若仍无满足 image.final_min_bytes 的最终图则返回失败。

9. 除上述外的其他参数将自动丢弃并忽略。

2. POST /v1/responses#

OpenAI Responses API 兼容接口，支持聊天对话、图像生成、图像编辑、视频生成。

调用示例（curl）

1
curl http://localhost:8000/v1/responses \
2
  -H "Content-Type: application/json" \
3
  -H "Authorization: Bearer $GROK2API_API_KEY" \
4
  -d '{
5
    "model": "grok-4",
6
    "input": "解释一下量子隧穿",
7
    "stream": true
8
  }'

支持的请求参数

注意事项

1. 内置工具 web_search / file_search / code_interpreter 目前会映射为 function tool 触发调用，但 不执行托管工具，需客户端自行执行并回填。

2. 流式输出会包含 response.output_text.* 与 response.function_call_arguments.* 事件。

3. POST /v1/images/generations#

OpenAI Image Generations API 兼容接口，支持图像生成。

调用示例（curl）

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

支持的请求参数

注意事项

1. quality、style 参数为 OpenAI 兼容保留，当前版本暂不支持自定义。

2. 多图编辑若传入超过 3 张，仅取最后 3 张 作为参考。

4. POST /v1/images/edits#

OpenAI Image Edits API 兼容接口，支持图像编辑（multipart/form-data）。

调用示例（curl）

1
curl http://localhost:8000/v1/images/edits \
2
  -H "Authorization: Bearer $GROK2API_API_KEY" \
3
  -F "model=grok-imagine-1.0-edit" \
4
  -F "prompt=把图片变清晰" \
5
  -F "image=@/path/to/image.png" \
6
  -F "n=1"

支持的请求参数

注意事项 quality、style 参数为 OpenAI 兼容保留，当前版本暂不支持自定义。

5. POST /v1/videos#

OpenAI Videos API 兼容接口，支持视频生成（multipart/form-data）。

调用示例（curl）

1
curl http://localhost:8000/v1/videos \
2
  -H "Content-Type: application/json" \
3
  -H "Authorization: Bearer $GROK2API_API_KEY" \
4
  -d '{
5
    "model": "grok-imagine-1.0-video",
6
    "prompt": "霓虹雨夜街头，慢镜头追拍",
7
    "size": "1792x1024",
8
    "seconds": 18,
9
    "quality": "standard"
10
  }'

支持的请求参数

注意事项

1. 服务端已支持 6~30 秒自动链式扩展， 无需使用 /v1/video/extend。

2. quality=standard 对应 480p；quality=high 对应 720p。

3. 基础号池请求 720p 时会先产出 480p 再按 video.upscale_timing 执行超分。

4. image_reference 与 input_reference 同时传入时，会按顺序作为参考图输入；视频链路只使用第 1 张。