Progrok

progrok — OAuth-Activated Grok Proxy and Tool Surface

progrok authenticates with xAI via OAuth (the same flow as the Grok web app) and activates that session as a local proxy plus direct CLI workflows. Any OpenAI-compatible client connects to the proxy with a placeholder key while progrok injects the real xAI OAuth bearer token locally.

This is an activation tool, not a bypass. Hermes Agent and OpenClaw document the same shared xAI OAuth client lineage, and Grok Build-style coding workflows can use the same account-backed session through progrok's localhost API surface.

When to Use

• Call xAI Grok models (chat, reasoning, vision, search, images, video, voice)
• No XAI_API_KEY available — activate the xAI OAuth session instead
• Real-time X/web search, image/video generation, TTS/STT, or RAG over your docs

Prerequisites

progrok login          # one-time OAuth (browser; or --device-code for SSH)
progrok status         # verify: "Status: Logged in"
progrok proxy          # start the proxy on 127.0.0.1:18645

The proxy strips your Authorization header and injects the OAuth token, so clients may send any placeholder bearer value.

Usage Patterns

Pattern 0: Native search (no proxy needed)

progrok search calls /v1/responses with the web_search/x_search server-side tools using your OAuth token directly. It is a fast (1–3s) terminal path for current research, but upstream account access, quota, and billing still belong to xAI.

progrok search "latest Node.js LTS version"      # web + X, AI summary + sources
progrok search "Tesla earnings reaction" --web   # web only
progrok search "what's trending in AI" --x        # X (Twitter) only
progrok search "react 19 release notes" --json   # {answer, citations, queries, usage}
progrok search "quantum news" --model grok-4.3    # pick the model

Output is an AI summary with inline [[n]](url) citations plus a deduplicated Sources list and a Markdown links block (human mode). Agents must use --json and paste citations[].url into their reply — paraphrasing answer alone drops links. JSON shape: { answer, citations[], queries[], usage }.

Pattern 1: Direct proxy (recommended for agents)

curl http://127.0.0.1:18645/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer anything" \
  -d '{"model": "grok-4.3", "messages": [{"role": "user", "content": "Hello"}]}'

Pattern 2: Responses API with tools

curl http://127.0.0.1:18645/v1/responses \
  -H "Content-Type: application/json" \
  -d '{
    "model": "grok-4.3",
    "input": [{"role": "user", "content": "What are people saying about Tesla on X?"}],
    "tools": [{"type": "x_search"}, {"type": "web_search"}],
    "stream": true
  }'

Pattern 3: Image generation / editing

# Generate (resolution 1k|2k, aspect_ratio, n, response_format url|b64_json)
curl http://127.0.0.1:18645/v1/images/generations \
  -H "Content-Type: application/json" \
  -d '{"model": "grok-imagine-image-quality", "prompt": "A futuristic cityscape", "resolution": "2k"}'

# Edit (single image or multi-reference compose)
curl http://127.0.0.1:18645/v1/images/edits \
  -H "Content-Type: application/json" \
  -d '{"model": "grok-imagine-image-quality", "prompt": "Make it a pencil sketch", "image": {"url": "https://.../photo.png"}}'

Pattern 4: Video generation (async — poll)

# Text-to-video
progrok video "Ocean waves crashing on rocks" --duration 8 --resolution 720p

# Image-to-video
progrok video "Animate this scene" --image photo.jpg --duration 10

# Reference-to-video (repeat --ref up to 7 times; max 10s)
progrok video "Use this character and outfit" --ref character.png --ref outfit.png --duration 6

# Video editing (real V2V — modify existing video, keep motion)
progrok video edit "Make the water glow neon blue" --video ./clip.mp4

# Video extension (continue from last frame)
progrok video extend "Camera slowly pulls back" --video file_id:file-abc123 --duration 5

API endpoints (via proxy at 127.0.0.1:18645):

# Generate: POST /v1/videos/generations
curl -s http://127.0.0.1:18645/v1/videos/generations \
  -H "Content-Type: application/json" \
  -d '{"model": "grok-imagine-video", "prompt": "Ocean waves", "duration": 8, "resolution": "720p"}'
# → {"request_id": "abc-123"}

# R2V: REST selects mode from reference_images; do not send a mode field
curl -s http://127.0.0.1:18645/v1/videos/generations \
  -H "Content-Type: application/json" \
  -d '{"model": "grok-imagine-video", "prompt": "Runway shot", "reference_images": [{"file_id": "file-abc123"}], "duration": 6}'

# Edit (V2V): POST /v1/videos/edits — grok-imagine-video only
curl -s http://127.0.0.1:18645/v1/videos/edits \
  -H "Content-Type: application/json" \
  -d '{"model": "grok-imagine-video", "prompt": "Add sunset colors", "video": {"url": "https://..."}}'

# Extend: POST /v1/videos/extensions — grok-imagine-video only, 2-10s
curl -s http://127.0.0.1:18645/v1/videos/extensions \
  -H "Content-Type: application/json" \
  -d '{"model": "grok-imagine-video", "prompt": "Continue scene", "duration": 5, "video": {"url": "https://..."}}'

# Poll: GET /v1/videos/{request_id}
curl http://127.0.0.1:18645/v1/videos/abc-123
# → {"status": "done", "video": {"url": "https://...", "duration": 8}}

Model constraints:

• grok-imagine-video: T2V, I2V, Ref2V, Edit, Extend — all modes
• grok-imagine-video-1.5-preview: live-smoked I2V only; prompt-only T2V and Ref2V return xAI 400 errors
• Media refs: url, file_id, data URI, or local file through the CLI
• REST has no mode field; SDK mode strings are provider options only
• image + reference_images is invalid
• Edit/Extend input: mp4, H.264/H.265/AV1, max 8.7s (edit) / 2-15s (extend)
• Edit output inherits input duration/aspect/resolution (max 720p)
• Extend duration: 2-10s added to original

Pattern 5: Voice — TTS / STT (HTTP)

# Text-to-speech (voices: eve, ara, leo, rex, sal). Returns audio bytes.
curl http://127.0.0.1:18645/v1/tts \
  -H "Content-Type: application/json" \
  -d '{"text": "Hello [pause] world", "voice_id": "eve", "language": "en"}' -o out.mp3

# List voices
curl http://127.0.0.1:18645/v1/tts/voices

# Speech-to-text (diarize, multichannel, word timestamps)
curl http://127.0.0.1:18645/v1/stt -F "file=@audio.mp3" -F "language=en" -F "diarize=true"

Realtime Voice Agent + streaming TTS/STT use WebSocket endpoints that the proxy does not forward. Mint a token with POST /v1/realtime/client_secrets and connect directly to wss://api.x.ai/v1/realtime.

Pattern 6: RAG over your documents

curl http://127.0.0.1:18645/v1/documents/search \
  -H "Content-Type: application/json" \
  -d '{"query": "Q3 revenue?", "source": {"collection_ids": ["collection_..."]}}'

Or enable the collections_search tool in /v1/responses. (Creating collections uses the Management API on management-api.x.ai — not proxied.)

Pattern 7: OpenAI SDK / LangChain

from openai import OpenAI
client = OpenAI(base_url="http://127.0.0.1:18645/v1", api_key="anything")
resp = client.chat.completions.create(
    model="grok-4.3",
    messages=[{"role": "user", "content": "Hello"}],
)

API Surface (HTTP — proxied)

Full request/response contracts: see docs/api.md. Live metadata: progrok capabilities --json.

Models

Chat / vision (input: text + image)

Cached input $0.20/1M. Above the 200K long-context threshold, chat rates double ($2.50 / $5.00 in/out; cached $0.40). Live search $25 / 1K sources.

Aliases: grok-4.3 also answers to grok-latest, grok-4, grok-4-fast-reasoning, grok-3, grok-3-mini, … Use <model>-latest to auto-track the newest version, <model>-<date> to pin a release.

Media & voice

Reasoning effort

grok-4.3 has configurable reasoning incl. a non-reasoning mode. The 4.20 reasoning line accepts reasoning.effort of low/high. For grok-4.20-multi-agent, effort selects agent count: low/medium → 4 agents, high/xhigh → 16 agents (Responses API only; no function calling).

Tools (Responses API)

{"tools": [
  {"type": "web_search", "enable_image_search": true},
  {"type": "x_search"},
  {"type": "code_interpreter"},
  {"type": "collections_search"},
  {"type": "mcp", "server_url": "https://mcp.deepwiki.com/mcp", "server_label": "deepwiki"},
  {"type": "function", "name": "my_func", "parameters": {}}
]}

• web_search — allowed_domains/excluded_domains (≤5), enable_image_understanding, enable_image_search.
• x_search — X posts/users/threads with citations.
• code_interpreter — server-side Python sandbox.
• collections_search — RAG over your collections.
• mcp — remote MCP server (server_url, server_label, allowed_tools).
• function — client-side function calling (≤128).

Structured Output (JSON Schema)

curl http://127.0.0.1:18645/v1/responses \
  -H "Content-Type: application/json" \
  -d '{
    "model": "grok-4.3",
    "input": [{"role": "user", "content": "Latest AI releases"}],
    "tools": [{"type": "web_search"}],
    "text": {"format": {"type": "json_schema", "name": "results",
      "schema": {"type": "object", "properties": {"items": {"type": "array", "items": {"type": "string"}}}, "required": ["items"]},
      "strict": true}}
  }'

Ports & Paths

• Proxy: 127.0.0.1:18645 · Chat UI: 127.0.0.1:18646 · OAuth callback: 127.0.0.1:56121
• Config: ~/.progrok/auth.json

Limitations

• WebSocket endpoints (wss /v1/realtime, /v1/tts, /v1/stt) are not proxied.
• Collection management (management-api.x.ai) is not proxied; search is.
• grok-4.20-multi-agent needs the Responses API (not Chat Completions).

Dynamic Metadata

progrok capabilities          # human-readable
progrok capabilities --json   # structured JSON for agents
progrok models --detail       # live pricing + aliases
progrok billing               # plan tier, usage, remaining quota
progrok billing --json        # structured billing data for agents

Install

npm i -g progrok