Some checks failed
ClawSweeper Dispatch / dispatch (push) Has been cancelled
CodeQL / Security High (actions) (push) Has been cancelled
CodeQL / Security High (channel-runtime-boundary) (push) Has been cancelled
CodeQL / Security High (core-auth-secrets) (push) Has been cancelled
CodeQL / Security High (mcp-process-tool-boundary) (push) Has been cancelled
CodeQL / Security High (network-ssrf-boundary) (push) Has been cancelled
CodeQL / Security High (plugin-trust-boundary) (push) Has been cancelled
CodeQL / Security High (process-exec-boundary) (push) Has been cancelled
Docs Sync Publish Repo / sync-publish-repo (push) Has been cancelled
Docs / docs (push) Has been cancelled
OpenClaw Stable Main Closeout / Resolve stable release closeout inputs (push) Has been cancelled
OpenClaw Stable Main Closeout / Verify stable main closeout (push) Has been cancelled
Workflow Sanity / no-tabs (push) Has been cancelled
Workflow Sanity / actionlint (push) Has been cancelled
Workflow Sanity / generated-doc-baselines (push) Has been cancelled
CI / runner-admission (push) Has been cancelled
CI / preflight (push) Has been cancelled
CI / security-fast (push) Has been cancelled
CI / pnpm-store-warmup (push) Has been cancelled
CI / build-artifacts (push) Has been cancelled
CI / native-i18n (push) Has been cancelled
CI / ${{ matrix.check_name }} (push) Has been cancelled
CI / ${{ matrix.checkName }} (push) Has been cancelled
CI / checks-node-compat-node22 (push) Has been cancelled
CI / check-bundled-channel-config-metadata (push) Has been cancelled
CI / check-dependencies (push) Has been cancelled
CI / check-guards (push) Has been cancelled
CI / check-lint (push) Has been cancelled
CI / check-prod-types (push) Has been cancelled
CI / check-shrinkwrap (push) Has been cancelled
CI / check-test-types (push) Has been cancelled
CI / check-additional-boundaries-a (push) Has been cancelled
CI / check-additional-boundaries-bcd (push) Has been cancelled
CI / check-additional-extension-bundled (push) Has been cancelled
CI / check-additional-extension-channels (push) Has been cancelled
CI / check-additional-extension-package-boundary (push) Has been cancelled
CI / check-additional-runtime-topology-architecture (push) Has been cancelled
CI / check-session-accessor-boundary (push) Has been cancelled
CI / check-session-transcript-reader-boundary (push) Has been cancelled
CI / check-docs (push) Has been cancelled
CI / skills-python (push) Has been cancelled
CI / macos-swift (push) Has been cancelled
CI / ios-build (push) Has been cancelled
CI / ci-timings-summary (push) Has been cancelled
Native App Locale Refresh / Refresh native fa (push) Has been cancelled
Native App Locale Refresh / Refresh native fr (push) Has been cancelled
Native App Locale Refresh / Refresh native hi (push) Has been cancelled
Native App Locale Refresh / Refresh native id (push) Has been cancelled
Native App Locale Refresh / Refresh native it (push) Has been cancelled
Native App Locale Refresh / Refresh native ja-JP (push) Has been cancelled
Control UI Locale Refresh / plan (push) Has been cancelled
Control UI Locale Refresh / Refresh ${{ matrix.locale }} (push) Has been cancelled
Control UI Locale Refresh / Commit control UI locale refresh (push) Has been cancelled
Live Media Runner Image / Build live media runner image (push) Has been cancelled
Native App Locale Refresh / Refresh native ar (push) Has been cancelled
Native App Locale Refresh / Refresh native de (push) Has been cancelled
Native App Locale Refresh / Refresh native es (push) Has been cancelled
Native App Locale Refresh / Refresh native ko (push) Has been cancelled
Native App Locale Refresh / Refresh native nl (push) Has been cancelled
Native App Locale Refresh / Refresh native pl (push) Has been cancelled
Native App Locale Refresh / Refresh native pt-BR (push) Has been cancelled
Native App Locale Refresh / Refresh native ru (push) Has been cancelled
Native App Locale Refresh / Refresh native sv (push) Has been cancelled
Native App Locale Refresh / Refresh native th (push) Has been cancelled
Native App Locale Refresh / Refresh native tr (push) Has been cancelled
Native App Locale Refresh / Refresh native uk (push) Has been cancelled
Native App Locale Refresh / Refresh native vi (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-CN (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-TW (push) Has been cancelled
Native App Locale Refresh / Commit native locale refresh (push) Has been cancelled
Plugin Init Scaffold Validation / Validate provider scaffold (push) Has been cancelled
Plugin NPM Release / preview_plugins_npm (push) Has been cancelled
Plugin NPM Release / Validate release publish approval (push) Has been cancelled
Plugin NPM Release / preview_plugin_pack (push) Has been cancelled
Plugin NPM Release / publish_plugins_npm (push) Has been cancelled
Sandbox Common Smoke / sandbox-common-smoke (push) Has been cancelled
Website Installer Sync / static (push) Has been cancelled
Website Installer Sync / linux-docker (push) Has been cancelled
Website Installer Sync / macos-installer (push) Has been cancelled
Website Installer Sync / windows-installer (push) Has been cancelled
Website Installer Sync / sync-website (push) Has been cancelled
Adolf is a fork/vendored clone of github.com/openclaw/openclaw (v2026.6.11), free to diverge. Tree copied sans upstream .git; upstream remote added for future syncs. Node pinned to 24 (.nvmrc); engines already require >=22.19. Preserves docs/ARCHITECTURE.md. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LeqyaxJF2nbRXJtae2kNB2
124 lines
4.0 KiB
Markdown
124 lines
4.0 KiB
Markdown
---
|
|
summary: "Grok web search via xAI web-grounded responses"
|
|
read_when:
|
|
- You want to use Grok for web_search
|
|
- You want to use xAI OAuth or an XAI_API_KEY for web search
|
|
title: "Grok search"
|
|
---
|
|
|
|
OpenClaw supports Grok as a `web_search` provider, using xAI web-grounded
|
|
responses to produce AI-synthesized answers backed by live search results
|
|
with citations.
|
|
|
|
Grok web search prefers an existing xAI OAuth sign-in when one is available.
|
|
If no OAuth profile exists, the same xAI API key also powers the built-in
|
|
`x_search` tool for X (formerly Twitter) post search and the `code_execution`
|
|
tool. Storing the key at `plugins.entries.xai.config.webSearch.apiKey` also
|
|
lets OpenClaw reuse it as a fallback for the bundled xAI model provider.
|
|
|
|
For post-level X metrics (reposts, replies, bookmarks, views), use
|
|
[`x_search`](/tools/web#x_search) with the exact post URL or status ID
|
|
instead of a broad search query.
|
|
|
|
## Onboarding and configure
|
|
|
|
Choosing **Grok** during `openclaw onboard` or `openclaw configure --section
|
|
web` lets OpenClaw reuse an existing xAI OAuth profile without prompting for
|
|
a separate web-search key. Without OAuth, it falls back to xAI API-key setup.
|
|
|
|
OpenClaw then offers a follow-up step to enable `x_search` with the same xAI
|
|
credential. That follow-up:
|
|
|
|
- only appears after you choose Grok for `web_search`
|
|
- is not a separate top-level web-search provider choice
|
|
- can optionally set the `x_search` model in the same flow
|
|
|
|
Skip it to enable or change `x_search` later in config.
|
|
|
|
## Sign in or get an API key
|
|
|
|
<Steps>
|
|
<Step title="Use xAI OAuth">
|
|
If you already signed in with xAI during onboarding or model auth, choose
|
|
Grok as the `web_search` provider. No separate API key is required:
|
|
|
|
```bash
|
|
openclaw onboard --auth-choice xai-oauth
|
|
openclaw config set tools.web.search.provider grok
|
|
```
|
|
|
|
</Step>
|
|
<Step title="Use an API key fallback">
|
|
Get an API key from [xAI](https://console.x.ai/) when OAuth is unavailable
|
|
or you intentionally want key-backed web-search config.
|
|
</Step>
|
|
<Step title="Store the key">
|
|
Set `XAI_API_KEY` in the Gateway environment, or configure via:
|
|
|
|
```bash
|
|
openclaw configure --section web
|
|
```
|
|
|
|
</Step>
|
|
</Steps>
|
|
|
|
## Config
|
|
|
|
```json5
|
|
{
|
|
plugins: {
|
|
entries: {
|
|
xai: {
|
|
config: {
|
|
webSearch: {
|
|
apiKey: "xai-...", // optional if xAI OAuth or XAI_API_KEY is available
|
|
baseUrl: "https://api.x.ai/v1", // optional Responses API proxy/base URL override
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
tools: {
|
|
web: {
|
|
search: {
|
|
provider: "grok",
|
|
},
|
|
},
|
|
},
|
|
}
|
|
```
|
|
|
|
**Credential alternatives:** `openclaw models auth login --provider xai
|
|
--method oauth`, `XAI_API_KEY` in the Gateway environment, or
|
|
`plugins.entries.xai.config.webSearch.apiKey`. For a gateway install, put env
|
|
vars in `~/.openclaw/.env`.
|
|
|
|
## How it works
|
|
|
|
Grok uses xAI web-grounded responses to synthesize answers with inline
|
|
citations, similar to Gemini's Google Search grounding approach.
|
|
|
|
## Supported parameters
|
|
|
|
Grok search supports `query`. `count` is accepted for shared `web_search`
|
|
compatibility, but Grok always returns one synthesized answer with citations
|
|
rather than an N-result list. Provider-specific filters are not supported.
|
|
|
|
Grok defaults to a 60 second timeout because xAI Responses web-grounded
|
|
searches can run longer than the shared `web_search` default. Override it
|
|
with `tools.web.search.timeoutSeconds`.
|
|
|
|
## Base URL overrides
|
|
|
|
Set `plugins.entries.xai.config.webSearch.baseUrl` to route Grok web search
|
|
through an operator proxy or xAI-compatible Responses endpoint. OpenClaw
|
|
posts to `<baseUrl>/responses` after trimming trailing slashes. `x_search`
|
|
falls back to the same `webSearch.baseUrl` unless
|
|
`plugins.entries.xai.config.xSearch.baseUrl` is set.
|
|
|
|
## Related
|
|
|
|
- [Web Search overview](/tools/web) -- all providers and auto-detection
|
|
- [x_search in Web Search](/tools/web#x_search) -- first-class X search via xAI
|
|
- [Gemini Search](/tools/gemini-search) -- AI-synthesized answers via Google grounding
|