跳转到内容

xAI

OpenClaw 内置了用于 Grok 模型的捆绑 OpenClawxaiOAuthOpenClawGateway(网关)API 提供商插件。对于大多数 用户而言,推荐的路径是使用符合条件的 SuperGrok 或 X Premium 订阅进行 Grok OAuth。OpenClaw 保持本地优先:Gateway(网关)、配置、路由和 工具在您的机器上运行,而 Grok 模型请求通过 xAI 进行身份验证 并发送到 xAI 的 API。

OAuth 不需要 xAI API 密钥,也不需要 Grok Build 应用。xAI 仍可能在同意屏幕上显示 Grok Build,因为 OpenClaw 使用 的是 xAI 的共享 OAuth 客户端。

使用与您的 OpenClaw 安装状态相匹配的路径:

  1. OpenClaw新的 OpenClaw 安装

    在设置新的本地 Gateway(网关)时,运行带有守护进程安装的新手引导,然后在模型/身份验证步骤中选择 xAI/Grok OAuth 选项:

    Terminal window
    openclaw onboard --install-daemon

    在 VPS 或通过 SSH 上,在引导过程中使用 device-code:

    Terminal window
    openclaw onboard --install-daemon --auth-choice xai-device-code
    ```OAuthAPIOpenClawOpenClawOAuth
    OAuth 不需要 xAI API 密钥。OpenClaw 不需要 Grok
    Build 应用。xAI 可能仍会将同意应用标记为 Grok Build,因为
    OpenClaw 使用 xAI 的共享 OAuth 客户端。
  2. Existing OpenClaw install

    如果已配置 OpenClaw,请仅登录 xAI。不要为了连接 Grok 而重新运行完整的 新手引导或重新安装守护程序:

    Terminal window
    openclaw models auth login --provider xai --method oauth

    当 Gateway(网关) 通过 SSH、Docker 或 VPS 运行,且本地主机浏览器回调不便时,请改用设备代码流程:

    Terminal window
    openclaw models auth login --provider xai --device-code

    要在登录后将 Grok 设为默认模型,请单独应用:

    Terminal window
    openclaw models set xai/grok-4.3

    仅当您有意更改 Gateway(网关)、 守护程序、渠道、工作区或其他设置选项时,才重新运行完整的新手引导。

  3. API-key path

    API 密钥设置仍适用于 xAI Console 密钥以及需要 密钥支持提供商配置的媒体表面:

    Terminal window
    openclaw models auth login --provider xai --method api-key
    export XAI_API_KEY=xai-...
  4. Pick a 模型

    {
    agents: { defaults: { model: { primary: "xai/grok-4.3" } } },
    }
  • 如果浏览器 OAuth 无法访问 OAuth127.0.0.1:56121,请使用 openclaw models auth login --provider xai --device-code

  • 如果登录成功但 Grok 不是默认模型,请运行 openclaw models set xai/grok-4.3

  • 要检查已保存的 xAI 身份验证配置文件,请运行:

    Terminal window
    openclaw models auth list --provider xai
    openclaw models status
  • xAI 决定哪些帐户可以接收 OAuth API 令牌。如果帐户不符合条件, 请尝试使用 API 密钥路径或在 xAI 端检查订阅。

OpenClaw 默认包含当前的 xAI 聊天模型,在模型选择器中按从新到旧排序:

系列模型 ID
Grok Build 0.1grok-build-0.1
Grok 4.3grok-4.3
Grok 4.20 Betagrok-4.20-beta-latest-reasoning, grok-4.20-beta-latest-non-reasoning

该插件仍然会为现有配置向前解析旧的 Grok 3、Grok 4、Grok 4 Fast、Grok 4.1 Fast 和 Grok Code 别名。官方的 Grok Code Fast 别名 规范化为 grok-build-0.1OpenClaw;OpenClaw 不再在可选目录中显示其他已停用的 上游别名。

内置插件将 xAI 当前的公共 API 接口映射到 OpenClaw 的共享提供商和工具合约。不符合共享合约的功能(例如流式 TTS 和实时语音)不会公开 - 请参阅下表。

xAI 功能OpenClaw 接口状态
聊天 / 回复xai/<model> 模型提供商
服务器端网络搜索web_search 提供商 grok
服务器端 X 搜索x_search 工具
服务器端代码执行code_execution 工具
图像image_generate
视频video_generate
批量文本转语音messages.tts.provider: "xai" / tts
流式 TTS-未公开;OpenClaw 的 TTS 合约返回完整的音频缓冲区
批量语音转文本tools.media.audio / 媒体理解
流式语音转文本语音通话 streaming.provider: "xai"
实时语音-尚未公开;使用不同的会话/WebSocket 合约
文件 / 批处理仅通用模型 API 兼容不是 OpenClaw 的一等工具

/fast onagents.defaults.models["xai/<model>"].params.fastMode: true 按如下方式重写原生 xAI 请求:

源模型快速模式目标
grok-3grok-3-fast
grok-3-minigrok-3-mini-fast
grok-4grok-4-fast
grok-4-0709grok-4-fast

旧版别名仍会规范化为标准的捆绑 ID:

旧版别名标准 ID
grok-code-fast-1grok-build-0.1
grok-code-fastgrok-build-0.1
grok-code-fast-1-0825grok-build-0.1
grok-4-fast-reasoninggrok-4-fast
grok-4-1-fast-reasoninggrok-4-1-fast
grok-4.20-reasoninggrok-4.20-beta-latest-reasoning
grok-4.20-non-reasoninggrok-4.20-beta-latest-non-reasoning
Web search

捆绑的 grokOAuth 网络搜索提供商优先使用 xAI OAuth,然后回退到 XAI_API_KEY 或插件网络搜索密钥:

Terminal window
openclaw models auth login --provider xai --method oauth
openclaw config set tools.web.search.provider grok
视频生成

捆绑的 xai 插件通过共享的 video_generate 工具注册了视频生成功能。

  • 默认视频模型:xai/grok-imagine-video
  • 模式:text-to-video(文本生成视频)、image-to-video(图像生成视频)、reference-image generation(参考图像生成)、remote video edit(远程视频编辑)以及 remote video extension(远程视频扩展)
  • 宽高比:1:116:99:164:33:43:22:3
  • 分辨率:480P720P
  • 时长:生成/图像生成视频为 1-15 秒,使用 reference_image 角色时为 1-10 秒,扩展为 2-10 秒
  • 参考图像生成:将每个提供的图像的 imageRoles 设置为 reference_image;xAI 最多接受 7 张此类图像
  • 默认操作超时:600 秒,除非设置了 video_generate.timeoutMsagents.defaults.videoGenerationModel.timeoutMs

要将 xAI 用作默认视频提供商:

{
agents: {
defaults: {
videoGenerationModel: {
primary: "xai/grok-imagine-video",
},
},
},
}
图像生成

捆绑的 xai 插件通过共享的 image_generate 工具注册图像生成功能。

  • 默认图像模型:xai/grok-imagine-image
  • 附加模型:xai/grok-imagine-image-quality
  • 模式:文生图和参考图编辑
  • 参考输入:一个 image 或最多五个 images
  • 宽高比:1:116:99:164:33:42:33:2
  • 分辨率:1K2K
  • 数量:最多 4 张图片
  • 默认操作超时:600 秒,除非设置了 image_generate.timeoutMsagents.defaults.imageGenerationModel.timeoutMs

OpenClaw 向 xAI 请求 b64_json 图像响应,以便生成的媒体可以 通过正常渠道附件路径进行存储和传递。本地 参考图像被转换为数据 URL;远程 http(s) 引用则 直接透传。

要将 xAI 用作默认图像提供商:

{
agents: {
defaults: {
imageGenerationModel: {
primary: "xai/grok-imagine-image",
},
},
},
}
文本转语音

捆绑的 xai 插件通过共享的 tts 提供商表面注册文本转语音。

  • Voices: eve, ara, rex, sal, leo, una
  • Default voice: eve
  • Formats: mp3, wav, pcm, mulaw, alaw
  • Language: BCP-47 code or auto
  • Speed: 提供商原生速度覆盖
  • 不支持原生 Opus 语音笔记格式

要将 xAI 用作默认的 TTS 提供商:

{
messages: {
tts: {
provider: "xai",
providers: {
xai: {
speakerVoiceId: "eve",
},
},
},
},
}
语音转文本

捆绑的 xaiOpenClaw 插件通过 OpenClaw 的 媒体理解转录表面注册批量语音转文本功能。

  • 默认模型: grok-stt
  • 端点: xAI REST /v1/sttOpenClaw
  • 输入路径: 多部分音频文件上传
  • OpenClaw 在任何使用 tools.media.audioDiscord 进行入站音频转录的地方均提供支持, 包括 Discord 语音频道片段和 渠道音频附件

要强制为入站音频转录使用 xAI:

{
tools: {
media: {
audio: {
models: [
{
type: "provider",
provider: "xai",
model: "grok-stt",
},
],
},
},
},
}
```OpenClaw
语言可以通过共享音频媒体配置或每次调用
转录请求提供。共享的 OpenClaw 表面接受提示提示(Prompt hints),但 xAI REST STT 集成
仅转发文件、模型和语言,因为它们能清晰地映射到当前的公共 xAI 端点。
流式语音转文本

捆绑的 xai 插件还为实时语音通话音频注册了一个实时转录提供商。

  • 端点:xAI WebSocket wss://api.x.ai/v1/stt
  • 默认编码:mulaw
  • 默认采样率:8000
  • 默认端点检测:800ms
  • 中间转录:默认启用

语音通话的 Twilio 媒体流发送 G.711 µ-law 音频帧,因此 xAI 提供商可以直接转发这些帧而无需转码:

{
plugins: {
entries: {
"voice-call": {
config: {
streaming: {
enabled: true,
provider: "xai",
providers: {
xai: {
apiKey: "${XAI_API_KEY}",
endpointingMs: 800,
language: "en",
},
},
},
},
},
},
},
}

提供商拥有的配置位于 plugins.entries.voice-call.config.streaming.providers.xai 之下。支持的键为 apiKeybaseUrlsampleRateencodingpcmmulawalaw)、interimResultsendpointingMslanguage

x_search 配置

内置的 xAI 插件将 x_searchOpenClaw 暴露为 OpenClaw 工具,用于通过 Grok 搜索 X(前身为 Twitter)内容。

配置路径:plugins.entries.xai.config.xSearch

KeyTypeDefaultDescription
enabledboolean-启用或禁用 x_search
modelstringgrok-4-1-fast用于 x_search 请求的模型
baseUrlstring-xAI Responses 基础 URL 覆盖
inlineCitationsboolean-在结果中包含内联引用
maxTurnsnumber-最大对话轮次
timeoutSecondsnumber-请求超时(秒)
cacheTtlMinutesnumber-缓存生存时间(分钟)
{
plugins: {
entries: {
xai: {
config: {
xSearch: {
enabled: true,
model: "grok-4-1-fast",
baseUrl: "https://api.x.ai/v1",
inlineCitations: true,
},
},
},
},
},
}
代码执行配置

内置的 xAI 插件将 code_executionOpenClaw 暴露为 OpenClaw 工具,用于在 xAI 的沙盒环境中远程执行代码。

配置路径:plugins.entries.xai.config.codeExecution

KeyTypeDefaultDescription
enabledbooleantrue (if key available)启用或禁用代码执行
modelstringgrok-4-1-fast用于代码执行请求的模型
maxTurnsnumber-最大对话轮次
timeoutSecondsnumber-请求超时(秒)
{
plugins: {
entries: {
xai: {
config: {
codeExecution: {
enabled: true,
model: "grok-4-1-fast",
},
},
},
},
},
}
已知限制
  • xAI 认证可以使用 API 密钥、环境变量、插件配置回退、 浏览器 OAuth,或设备代码 OAuth,需配合符合条件的 xAI 账户。浏览器 OAuth 在 127.0.0.1:56121 上使用本地回调;对于远程主机,请使用 xai-device-code,除非您想在打开登录 URL 之前转发该端口。xAI 决定哪些账户可以接收 OAuth API 令牌,并且 即使 OpenClaw 不需要 Grok Build 应用程序,同意页面也可能会显示 Grok Build。 - grok-4.20-multi-agent-experimental-beta-0304 在 常规 xAI 提供商路径上不受支持,因为它需要与标准 API xAI 传输不同的上游 OpenClaw 接口。 - xAI Realtime 语音尚未注册为 OpenClaw 提供商。它 需要与批量 STT 或 流式转录不同的双向语音会话协议。 - xAI 图像 quality、图像 mask 和额外的仅限本机的宽高比 在共享 image_generate 工具具有相应的 跨提供商控制之前,不会公开。
Advanced notes
  • OpenClaw 会在共享运行程序路径上自动应用 xAI 特定的工具架构和工具调用兼容性修复。
  • 原生 xAI 请求默认启用 tool_stream: true。将 `agents.defaults.models[“xai/

“].params.tool_stream设置为false即可 禁用它。 - 捆绑的 xAI 封装器会在发送原生 xAI 请求之前,去除不支持的工具架构严格标志和 推理负载键。 -web_searchx_searchcode_executionOpenClawOpenClaw 作为 OpenClaw 工具公开。OpenClaw 会在每个工具请求内部启用其所需的特定 xAI 内置功能, 而不是将所有原生工具附加到每次对话轮次中。 - Grok web_search读取plugins.entries.xai.config.webSearch.baseUrlx_search读取plugins.entries.xai.config.xSearch.baseUrl,然后 回退到 Grok 网络搜索基础 URL。 - x_searchcode_execution由捆绑的 xAI 插件拥有,而不是 硬编码到核心模型运行时中。 -code_execution 是远程 xAI 沙箱执行,而非本地 [exec`](/zh/tools/exec)。

xAI 媒体路径包含单元测试和可选的实时测试套件。在运行实时探测之前, 请在进程环境中导出 XAI_API_KEY

Terminal window
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_TEST_QUIET=1 OPENCLAW_LIVE_IMAGE_GENERATION_PROVIDERS=xai pnpm test:live -- test/image-generation.runtime.live.test.ts

特定提供商的实时测试文件会合成常规 TTS、电话友好的 PCM TTS,通过 xAI 批量 STT 转录音频,通过 xAI 实时 STT 流式传输相同的 PCM,生成文本到图像输出,并编辑参考图像。 共享图像实时文件通过 OpenClaw 的 运行时选择、回退、规范化和媒体附加路径来验证同一个 xAI 提供商。

Model selection

选择提供商、模型引用和故障转移行为。

视频生成

共享的视频工具参数和提供商选择。

所有提供商

更广泛的提供商概述。

故障排除

常见问题和修复方法。