> ## Documentation Index
> Fetch the complete documentation index at: https://docs2.openclaw.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# xAI
OpenClaw ships a bundled `xai` provider plugin for Grok models. The
recommended path is Grok OAuth with an eligible SuperGrok or X Premium
subscription. Gateway, config, routing, and tools stay local; only Grok
requests go to xAI's API.
OAuth does not require an xAI API key or the Grok Build app. xAI may still
show Grok Build on the consent screen because OpenClaw uses xAI's shared
OAuth client.
## Setup
Run onboarding with daemon install, then pick xAI/Grok OAuth at the
model/auth step:
```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
openclaw onboard --install-daemon
```
On a VPS or over SSH, select xAI OAuth directly; it uses device-code
verification and does not need a localhost callback:
```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
openclaw onboard --install-daemon --auth-choice xai-oauth
```
Sign in to xAI only; do not rerun full onboarding just to connect Grok:
```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
openclaw models auth login --provider xai --method oauth
```
Apply Grok as the default model separately:
```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
openclaw models set xai/grok-4.3
```
Rerun full onboarding only if you intentionally want to change Gateway,
daemon, channel, workspace, or other setup choices.
API-key setup still works for xAI Console keys and for media surfaces
that need key-backed provider config:
```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
openclaw models auth login --provider xai --method api-key
export XAI_API_KEY=xai-...
```
```json5 theme={"theme":{"light":"min-light","dark":"min-dark"}}
{
agents: { defaults: { model: { primary: "xai/grok-4.3" } } },
}
```
OpenClaw uses the xAI Responses API as the bundled xAI transport. The same
credential from `openclaw models auth login --provider xai --method oauth` or
`--method api-key` also powers `web_search` (provider id `grok`), `x_search`,
`code_execution`, speech/transcription, and xAI image/video generation. If you
store an xAI key under `plugins.entries.xai.config.webSearch.apiKey`, the
bundled xAI model provider reuses it as a fallback too.
## OAuth troubleshooting
* For SSH, Docker, VPS, or other remote setups, use
`openclaw models auth login --provider xai --method oauth`; it uses
device-code verification, not a localhost callback.
* If sign-in succeeds but Grok is not the default model, run
`openclaw models set xai/grok-4.3`.
* Inspect saved xAI auth profiles:
```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
openclaw models auth list --provider xai
openclaw models status
```
* xAI decides which accounts can receive OAuth API tokens. If an account is
not eligible, use the API-key path or check the subscription on xAI's side.
Use `xai-oauth` when signing in from SSH, Docker, or a VPS. OpenClaw prints a
URL and short code; finish sign-in in any local browser while the remote
process polls xAI for the completed token exchange.
## Built-in catalog
Selectable ids in model pickers. The plugin still resolves older Grok 3,
Grok 4, Grok 4 Fast, Grok 4.1 Fast, and Grok Code ids for existing configs;
see [legacy compatibility and moving aliases](#legacy-compatibility-and-moving-aliases).
| Family | Model ids |
| -------------- | ------------------------------------------------------------ |
| Grok 4.5 | `grok-4.5` (aliases: `grok-4.5-latest`, `grok-build-latest`) |
| Grok Build 0.1 | `grok-build-0.1` |
| Grok 4.3 | `grok-4.3` (aliases: `grok-4.3-latest`, `grok-latest`) |
| Grok 4.20 | `grok-4.20-0309-reasoning`, `grok-4.20-0309-non-reasoning` |
Use `grok-4.5` for general chat, coding, and agentic work where it is available.
Grok 4.3 remains the regional-safe setup default; `grok-build-0.1` and both
dated Grok 4.20 variants remain selectable.
## Feature coverage
The bundled plugin maps supported xAI APIs onto OpenClaw's shared provider and
tool contracts. Capabilities that do not fit the shared contract are listed
below or under known limits.
| xAI capability | OpenClaw surface | Status |
| -------------------------- | --------------------------------------- | ---------------------------------------------------- |
| Chat / Responses | `xai/` model provider | Yes |
| Server-side web search | `web_search` provider `grok` | Yes |
| Server-side X search | `x_search` tool | Yes |
| Server-side code execution | `code_execution` tool | Yes |
| Images | `image_generate` | Yes |
| Videos | `video_generate` | Yes |
| Batch text-to-speech | `messages.tts.provider: "xai"` / `tts` | Yes |
| Streaming TTS | `textToSpeechStream` | Yes via `wss://api.x.ai/v1/tts` (not realtime voice) |
| Batch speech-to-text | `tools.media.audio` media understanding | Yes |
| Streaming speech-to-text | Voice Call `streaming.provider: "xai"` | Yes |
| Realtime voice | Talk `talk.realtime.provider: "xai"` | Yes; gateway-relay for native Talk nodes |
| Files / batches | Generic model API compatibility only | Not a first-class OpenClaw tool |
OpenClaw uses xAI's REST image/video/TTS/STT APIs for media generation and
batch transcription, xAI's streaming STT WebSocket for live voice-call
transcription, xAI's Grok Voice Agent WebSocket for Talk realtime sessions,
and the Responses API for chat, search, and code-execution tools.
### Legacy fast-mode compatibility
`/fast on` or `agents.defaults.models["xai/"].params.fastMode: true`
still rewrites older xAI configurations as follows. These target ids are
kept only for compatibility; use current selectable models for new
configurations.
| Source model | Fast-mode target |
| ------------- | ------------------ |
| `grok-3` | `grok-3-fast` |
| `grok-3-mini` | `grok-3-mini-fast` |
| `grok-4` | `grok-4-fast` |
| `grok-4-0709` | `grok-4-fast` |
### Legacy compatibility and moving aliases
Older aliases normalize as follows:
| Legacy alias | Normalized id |
| ------------------------------------------------------------- | ---------------- |
| `grok-code-fast-1`, `grok-code-fast`, `grok-code-fast-1-0825` | `grok-build-0.1` |
The dated 0309 ids are the selectable catalog entries. OpenClaw sends all other
current Grok 4.20 aliases verbatim so xAI retains control of stable, latest,
beta, experimental, and dated alias semantics. The global `grok-latest` alias is
also preserved verbatim.
xAI retired the following exact ids. OpenClaw keeps them as hidden compatibility
rows for shipped configurations, with the limits and pricing of their current
redirect targets:
| Retired ids | Current behavior |
| -------------------------------------------------------------------- | -------------------------------- |
| `grok-4-1-fast-reasoning`, `grok-4-fast-reasoning`, `grok-4-0709` | Grok 4.3 with `low` reasoning |
| `grok-4-1-fast-non-reasoning`, `grok-4-fast-non-reasoning`, `grok-3` | Grok 4.3 with reasoning disabled |
| `grok-code-fast-1` | Grok Build 0.1 |
| `grok-imagine-image-pro` | Grok Imagine Image Quality |
`openclaw doctor --fix` updates persisted xAI server-tool defaults and the
retired quality image slug, removes stale generated catalog rows, and repairs
stale context metadata on active 4.20 rows. It does not pin active 4.20
`beta-latest` aliases to a dated snapshot.
## Features
`x_search` and `code_execution` run on xAI's servers. xAI bills \$5 per 1,000
tool calls, plus the model's input and output tokens. With each tool's
`enabled` setting omitted, OpenClaw exposes it only for an active xAI model.
A known non-xAI model provider requires an explicit per-tool `enabled: true`;
a missing or unresolved provider fails closed. xAI auth is always required,
and `enabled: false` disables the tool for every provider.
The bundled `grok` web-search provider prefers xAI OAuth, then falls back
to `XAI_API_KEY` or a plugin web-search key:
```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
openclaw models auth login --provider xai --method oauth
openclaw config set tools.web.search.provider grok
```
The bundled `xai` plugin registers video generation through the shared
`video_generate` tool.
* Default model: `xai/grok-imagine-video`
* Additional model: `xai/grok-imagine-video-1.5`
* Classic modes: text-to-video, image-to-video, reference-image generation,
remote video edit, and remote video extension
* Video 1.5 mode: image-to-video only, with exactly one first-frame image
* Aspect ratios: `1:1`, `16:9`, `9:16`, `4:3`, `3:4`, `3:2`, `2:3`;
classic and Video 1.5 image-to-video inherit the source image ratio when
omitted
* Resolutions: classic `480P`/`720P`; Video 1.5 also supports `1080P`; all
generation modes default to `480P`
* Duration: 1-15 seconds for generation/image-to-video, 1-10 seconds when
using classic `reference_image` roles, 2-10 seconds for classic extension
* Reference-image generation: set `imageRoles` to `reference_image` for
every supplied image; xAI accepts up to 7 such images
* Video edit/extend inherit the input video's aspect ratio and resolution;
those operations do not accept geometry overrides
* Default operation timeout: 600 seconds unless `video_generate.timeoutMs`
or `agents.defaults.videoGenerationModel.timeoutMs` is set
Local video buffers are not accepted. Use remote `http(s)` URLs for video
edit/extend inputs. Image-to-video accepts local image buffers because
OpenClaw encodes those as data URLs for xAI.
Video 1.5 also recognizes xAI's `grok-imagine-video-1.5-preview` and
`grok-imagine-video-1.5-2026-05-30` identifiers. OpenClaw forwards the
selected identifier unchanged, but applies the same image-only validation.
To use xAI as the default video provider:
```json5 theme={"theme":{"light":"min-light","dark":"min-dark"}}
{
agents: {
defaults: {
videoGenerationModel: {
primary: "xai/grok-imagine-video",
},
},
},
}
```
See [Video Generation](/tools/video-generation) for shared tool
parameters, provider selection, and failover behavior.
The bundled `xai` plugin registers image generation through the shared
`image_generate` tool.
* Default image model: `xai/grok-imagine-image`
* Additional model: `xai/grok-imagine-image-quality`
* Modes: text-to-image and reference-image edit
* Reference inputs: one `image` or up to three `images`
* Aspect ratios: `1:1`, `16:9`, `9:16`, `4:3`, `3:4`, `3:2`, `2:3`, `2:1`,
`1:2`, `19.5:9`, `9:19.5`, `20:9`, `9:20`
* Resolutions: `1K`, `2K`
* Count: up to 4 images
* Default operation timeout: 600 seconds unless `image_generate.timeoutMs`
or `agents.defaults.imageGenerationModel.timeoutMs` is set
OpenClaw asks xAI for `b64_json` image responses so generated media can be
stored and delivered through the normal channel attachment path. Local
reference images are converted to data URLs; remote `http(s)` references
pass through unchanged.
To use xAI as the default image provider:
```json5 theme={"theme":{"light":"min-light","dark":"min-dark"}}
{
agents: {
defaults: {
imageGenerationModel: {
primary: "xai/grok-imagine-image",
},
},
},
}
```
xAI also documents `quality`, `mask`, `user`, and an `auto` aspect ratio.
OpenClaw forwards only the shared cross-provider image controls today;
these native-only knobs are not exposed through `image_generate`.
The bundled `xai` plugin registers text-to-speech through the shared `tts`
provider surface.
* Voices: authenticated live catalog from xAI; list it with
`openclaw infer tts voices --provider xai`
* Offline fallback voices: `ara`, `eve`, `leo`, `rex`, `sal`
* Default voice: `eve`
* Account custom voice IDs are forwarded even when they are absent from the
built-in catalog response
* Formats: `mp3`, `wav`, `pcm`, `mulaw`, `alaw`
* Language: BCP-47 code or `auto`
* Speed: provider-native speed override
* Native Opus voice-note format is not supported
To use xAI as the default TTS provider:
```json5 theme={"theme":{"light":"min-light","dark":"min-dark"}}
{
messages: {
tts: {
provider: "xai",
providers: {
xai: {
voiceId: "eve",
},
},
},
},
}
```
OpenClaw uses xAI's batch `/v1/tts` endpoint for buffered synthesis,
authenticated `/v1/tts/voices` catalog discovery, and native
`wss://api.x.ai/v1/tts` for streaming synthesis. Streaming is restricted to
the native `api.x.ai` host, so custom `baseUrl` values are rejected on this
path. It uses the existing language, voice, codec, and speed controls; xAI
defaults apply to sample rate and bit rate. Audio-file synthesis honors all
configured codecs. Voice-note targets use MP3 for streaming and buffered
fallback because xAI's raw codecs do not carry codec/rate metadata. The
stream sends `text.delta` then
`text.done`, receives `audio.delta`, `audio.done`, or `error`, and applies an
idle `timeoutMs` that refreshes for every audio chunk. It is separate from
realtime voice sessions. See xAI's [Streaming TTS API](https://docs.x.ai/developers/rest-api-reference/inference/voice) contract.
The bundled `xai` plugin registers batch speech-to-text through OpenClaw's
media-understanding transcription surface.
* Endpoint: xAI REST `/v1/stt`
* Input path: multipart audio file upload
* Model selection: xAI chooses the transcription model internally; the
endpoint has no model selector
* Used wherever inbound audio transcription reads `tools.media.audio`,
including Discord voice-channel segments and channel audio attachments
To force xAI for inbound audio transcription:
```json5 theme={"theme":{"light":"min-light","dark":"min-dark"}}
{
tools: {
media: {
audio: {
models: [
{
type: "provider",
provider: "xai",
},
],
},
},
},
}
```
Language can be supplied through the shared audio media config or per-call
transcription request. Prompt hints are accepted by the shared OpenClaw
surface, but the xAI REST STT integration forwards only file and language
because those map to the current public xAI endpoint.
The bundled `xai` plugin also registers a realtime transcription provider
for live voice-call audio.
* Endpoint: xAI WebSocket `wss://api.x.ai/v1/stt`
* Default encoding: `mulaw`
* Default sample rate: `8000`
* Default endpointing: `800ms`
* Interim transcripts: enabled by default
Voice Call's Twilio media stream sends G.711 mu-law audio frames, so the
xAI provider forwards those frames directly without transcoding:
```json5 theme={"theme":{"light":"min-light","dark":"min-dark"}}
{
plugins: {
entries: {
"voice-call": {
config: {
streaming: {
enabled: true,
provider: "xai",
providers: {
xai: {
apiKey: "${XAI_API_KEY}",
endpointingMs: 800,
language: "en",
},
},
},
},
},
},
},
}
```
Provider-owned config lives under
`plugins.entries.voice-call.config.streaming.providers.xai`. Supported
keys are `apiKey`, `baseUrl`, `sampleRate`, `encoding` (`pcm`, `mulaw`, or
`alaw`), `interimResults`, `endpointingMs`, and `language`.
This streaming provider is for Voice Call's realtime transcription path.
Discord voice records short segments and uses the batch
`tools.media.audio` transcription path instead.
The bundled `xai` plugin registers Grok Voice Agent realtime sessions for
Talk mode through the shared `registerRealtimeVoiceProvider` contract.
* Endpoint: `wss://api.x.ai/v1/realtime?model=`
* Default model: `grok-voice-latest`
* Default voice: `eve`
* Transport: `gateway-relay` (iOS, Android, and Control UI relay paths)
* Audio: PCM16 24 kHz or G.711 ยต-law 8 kHz
* Barge-in: xAI server VAD interrupts the response; OpenClaw clears queued playback
and truncates unplayed provider history
Configure Talk on the Gateway:
```json5 theme={"theme":{"light":"min-light","dark":"min-dark"}}
{
talk: {
realtime: {
provider: "xai",
mode: "realtime",
transport: "gateway-relay",
brain: "agent-consult",
providers: {
xai: {
model: "grok-voice-latest",
voice: "eve",
// Opt in only if provider-side session replay is acceptable.
sessionResumption: false,
},
},
},
},
env: { XAI_API_KEY: "xai-..." },
}
```
Provider-owned config also resolves from
`plugins.entries.voice-call.config.realtime.providers.xai` when Voice Call
or shared realtime selectors reuse the same provider map. Supported keys are
`apiKey`, `baseUrl`, `model`, `voice`, `vadThreshold`, `silenceDurationMs`,
`prefixPaddingMs`, `reasoningEffort`, and `sessionResumption`.
`reasoningEffort` accepts only `high` or `none`, matching the xAI Voice Agent API.
xAI's server VAD always creates responses and handles audio interruption.
Use `consultRouting: "provider-direct"`; forced transcript routing and disabling
input-audio interruption are not supported by the xAI Voice Agent protocol.
xAI OAuth or `XAI_API_KEY` can authenticate realtime voice. Browser-owned
WebRTC is not part of this provider surface yet; use gateway-relay Talk on
native nodes or the Control UI relay path.
`sessionResumption` defaults to `false`. When set to `true`, OpenClaw asks
xAI to retain enough session state to resume the same conversation after a
reconnect and then reconnects with the returned conversation id. Leave it
disabled when provider-side replay/retention is not acceptable; interrupted
sockets then fail closed instead of silently starting a fresh conversation.
The bundled xAI plugin exposes `x_search` as an OpenClaw tool for
searching X (formerly Twitter) content via Grok.
Config path: `plugins.entries.xai.config.xSearch`
| Key | Type | Default | Description |
| ----------------- | ------- | ------------------------ | ----------------------------------------------- |
| `enabled` | boolean | Automatic for xAI models | Disable, or opt in for a known non-xAI provider |
| `model` | string | `grok-4.3` | Model used for x\_search requests |
| `baseUrl` | string | - | xAI Responses base URL override |
| `inlineCitations` | boolean | - | Include inline citations in results |
| `maxTurns` | number | - | Maximum conversation turns |
| `timeoutSeconds` | number | `30` | Request timeout in seconds |
| `cacheTtlMinutes` | number | `15` | Cache time-to-live in minutes |
```json5 theme={"theme":{"light":"min-light","dark":"min-dark"}}
{
plugins: {
entries: {
xai: {
config: {
xSearch: {
enabled: true,
model: "grok-4.3",
baseUrl: "https://api.x.ai/v1",
inlineCitations: true,
},
},
},
},
},
}
```
The bundled xAI plugin exposes `code_execution` as an OpenClaw tool for
remote code execution in xAI's sandbox environment.
Config path: `plugins.entries.xai.config.codeExecution`
| Key | Type | Default | Description |
| ---------------- | ------- | ------------------------ | ----------------------------------------------- |
| `enabled` | boolean | Automatic for xAI models | Disable, or opt in for a known non-xAI provider |
| `model` | string | `grok-4.3` | Model used for code execution requests |
| `maxTurns` | number | - | Maximum conversation turns |
| `timeoutSeconds` | number | `30` | Request timeout in seconds |
This is remote xAI sandbox execution, not local [`exec`](/tools/exec).
```json5 theme={"theme":{"light":"min-light","dark":"min-dark"}}
{
plugins: {
entries: {
xai: {
config: {
codeExecution: {
enabled: true,
model: "grok-4.3",
},
},
},
},
},
}
```
* xAI auth can use an API key, environment variable, plugin config
fallback, or OAuth with an eligible xAI account. OAuth uses device-code
verification without a localhost callback. xAI decides which accounts
can receive OAuth API tokens, and the consent page may show Grok Build
even though OpenClaw does not require the Grok Build app.
* OpenClaw does not currently expose the xAI multi-agent model family. xAI
serves these models through the Responses API, but they do not accept
the client-side or custom tools used by OpenClaw's shared agent loop.
See the
[xAI multi-agent limitations](https://docs.x.ai/developers/model-capabilities/text/multi-agent#limitations).
* xAI Realtime voice currently exposes gateway-relay Talk transport only.
Browser-owned provider WebSocket sessions are not wired in the Control UI
yet.
* xAI image `quality`, image `mask`, and extra native-only aspect ratios are
not exposed until the shared `image_generate` tool has corresponding
cross-provider controls.
* OpenClaw applies xAI-specific tool-schema and tool-call compatibility
fixes automatically on the shared runner path.
* Native xAI requests default `tool_stream: true`. Set
`agents.defaults.models["xai/"].params.tool_stream` to `false`
to disable it.
* The bundled xAI wrapper strips unsupported contains-count schema bounds
and unsupported reasoning *effort* payload keys before sending native
xAI requests. Grok 4.5 supports low, medium, and
high effort (default high). Grok 4.3 supports none, low, medium, and high
effort (default low). Other reasoning-capable xAI models do not expose a
configurable effort control, but still request
`include: ["reasoning.encrypted_content"]` so prior encrypted reasoning
can be replayed on follow-up turns.
* `web_search`, `x_search`, and `code_execution` are exposed as OpenClaw
tools. OpenClaw attaches only the specific xAI built-in each tool needs
to that tool's request instead of attaching every native tool to every
chat turn.
* Grok `web_search` reads `plugins.entries.xai.config.webSearch.baseUrl`.
`x_search` reads `plugins.entries.xai.config.xSearch.baseUrl`, then
falls back to the Grok web-search base URL.
* `x_search` and `code_execution` are owned by the bundled xAI plugin
rather than hardcoded into the core model runtime.
* `code_execution` is remote xAI sandbox execution, not local
[`exec`](/tools/exec).
## Live testing
The xAI media paths are covered by unit tests and opt-in live suites. Export
`XAI_API_KEY` in the process environment before running live probes.
```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
pnpm test extensions/xai
OPENCLAW_LIVE_TEST=1 OPENCLAW_LIVE_TEST_QUIET=1 pnpm test:live -- extensions/xai/xai.live.test.ts
OPENCLAW_LIVE_TEST=1 OPENCLAW_LIVE_XAI_VIDEO=1 pnpm test:live -- extensions/xai/xai.live.test.ts -t "classic Grok Imagine"
OPENCLAW_LIVE_TEST=1 OPENCLAW_LIVE_XAI_VIDEO=1 pnpm test:live -- extensions/xai/xai.live.test.ts -t "Grok Imagine Video 1.5"
OPENCLAW_LIVE_TEST=1 OPENCLAW_LIVE_TEST_QUIET=1 pnpm test:live -- extensions/xai/x-search.live.test.ts
OPENCLAW_LIVE_GATEWAY_MODELS="xai/grok-4.5,xai/grok-build-0.1,xai/grok-4.3,xai/grok-4.20-0309-reasoning,xai/grok-4.20-0309-non-reasoning" OPENCLAW_LIVE_GATEWAY_MAX_MODELS=0 OPENCLAW_LIVE_GATEWAY_SMOKE=0 pnpm test:live -- src/gateway/gateway-models.profiles.live.test.ts
OPENCLAW_LIVE_TEST=1 OPENCLAW_LIVE_TEST_QUIET=1 OPENCLAW_LIVE_IMAGE_GENERATION_PROVIDERS=xai pnpm test:live -- test/image-generation.runtime.live.test.ts
```
The provider-specific live file synthesizes normal TTS, telephony-friendly PCM
TTS, transcribes audio through xAI batch STT, streams the same PCM through xAI
realtime STT, generates text-to-image output, and edits a reference image.
The shared image live file verifies the same xAI provider through OpenClaw's
runtime selection, fallback, normalization, and media attachment path. The
opt-in Video 1.5 case submits one generated first-frame image at 1080P and
verifies the completed video download.
## Related
Choosing providers, model refs, and failover behavior.
Shared video tool parameters and provider selection.
The broader provider overview.
Common issues and fixes.