Zum Hauptinhalt springen

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

OpenClaw liefert ein gebündeltes xai-Provider-Plugin für Grok-Modelle aus.

Erste Schritte

1

API-Schlüssel erstellen

Erstellen Sie einen API-Schlüssel in der xAI-Konsole.
2

Ihren API-Schlüssel festlegen

Legen Sie XAI_API_KEY fest, oder führen Sie aus:
openclaw onboard --auth-choice xai-api-key
3

Ein Modell auswählen

{
  agents: { defaults: { model: { primary: "xai/grok-4.3" } } },
}
OpenClaw verwendet die xAI Responses API als gebündelten xAI-Transport. Derselbe API-Schlüssel aus openclaw onboard --auth-choice xai-api-key kann auch erstklassiges x_search und remote code_execution bereitstellen; XAI_API_KEY oder die Plugin-Konfiguration für Websuche kann auch Grok-gestütztes web_search bereitstellen. Wenn Sie einen xAI-Schlüssel unter plugins.entries.xai.config.webSearch.apiKey speichern, verwendet der gebündelte xAI-Modell-Provider diesen Schlüssel auch als Fallback. Setzen Sie plugins.entries.xai.config.webSearch.baseUrl, um Grok web_search und standardmäßig x_search über einen Betreiber-xAI-Responses-Proxy zu leiten. Die Abstimmung von code_execution befindet sich unter plugins.entries.xai.config.codeExecution.

Integrierter Katalog

OpenClaw enthält diese xAI-Modellfamilien standardmäßig:
FamilieModell-IDs
Grok 3grok-3, grok-3-fast, grok-3-mini, grok-3-mini-fast
Grok 4.3grok-4.3
Grok 4grok-4, grok-4-0709
Grok 4 Fastgrok-4-fast, grok-4-fast-non-reasoning
Grok 4.1 Fastgrok-4-1-fast, grok-4-1-fast-non-reasoning
Grok 4.20 Betagrok-4.20-beta-latest-reasoning, grok-4.20-beta-latest-non-reasoning
Grok Codegrok-code-fast-1
Das Plugin löst auch neuere grok-4*- und grok-code-fast*-IDs weiter auf, wenn sie derselben API-Struktur folgen.
grok-4.3, grok-4-fast, grok-4-1-fast und die grok-4.20-beta-*-Varianten sind die aktuellen bildfähigen Grok-Referenzen im gebündelten Katalog.

OpenClaw-Funktionsabdeckung

Das gebündelte Plugin bildet die aktuelle öffentliche API-Oberfläche von xAI auf die gemeinsamen Provider- und Tool-Verträge von OpenClaw ab. Fähigkeiten, die nicht zum gemeinsamen Vertrag passen (zum Beispiel Streaming-TTS und Echtzeit-Sprache), werden nicht bereitgestellt - siehe die Tabelle unten.
xAI-FähigkeitOpenClaw-OberflächeStatus
Chat / Responsesxai/<model>-Modell-ProviderJa
Serverseitige Websucheweb_search-Provider grokJa
Serverseitige X-Suchex_search-ToolJa
Serverseitige Codeausführungcode_execution-ToolJa
Bilderimage_generateJa
Videosvideo_generateJa
Batch-Text-zu-Sprachemessages.tts.provider: "xai" / ttsJa
Streaming-TTS-Nicht bereitgestellt; der TTS-Vertrag von OpenClaw gibt vollständige Audiopuffer zurück
Batch-Sprache-zu-Texttools.media.audio / MedienverständnisJa
Streaming-Sprache-zu-TextVoice Call streaming.provider: "xai"Ja
Echtzeit-Sprache-Noch nicht bereitgestellt; anderer Sitzungs-/WebSocket-Vertrag
Dateien / BatchesNur generische Modell-API-KompatibilitätKein erstklassiges OpenClaw-Tool
OpenClaw verwendet die REST-APIs von xAI für Bild/Video/TTS/STT für Mediengenerierung, Sprache und Batch-Transkription, das Streaming-STT-WebSocket von xAI für Live-Transkription von Sprachanrufen und die Responses API für Modell-, Such- und Codeausführungs-Tools. Funktionen, die andere OpenClaw-Verträge benötigen, etwa Echtzeit-Sprachsitzungen, werden hier als Upstream-Fähigkeiten dokumentiert und nicht als verborgenes Plugin-Verhalten.

Fast-Modus-Zuordnungen

/fast on oder agents.defaults.models["xai/<model>"].params.fastMode: true schreibt native xAI-Anfragen wie folgt um:
QuellmodellFast-Modus-Ziel
grok-3grok-3-fast
grok-3-minigrok-3-mini-fast
grok-4grok-4-fast
grok-4-0709grok-4-fast

Legacy-Kompatibilitätsaliase

Legacy-Aliase werden weiterhin auf die kanonischen gebündelten IDs normalisiert:
Legacy-AliasKanonische ID
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

Funktionen

Der gebündelte grok-Websuche-Provider kann XAI_API_KEY oder einen Plugin-Schlüssel für Websuche verwenden:
openclaw config set tools.web.search.provider grok
Das gebündelte xai-Plugin registriert Videogenerierung über das gemeinsame video_generate-Tool.
  • Standard-Videomodell: xai/grok-imagine-video
  • Modi: Text-zu-Video, Bild-zu-Video, Referenzbildgenerierung, Remote-Video-Bearbeitung und Remote-Video-Erweiterung
  • Seitenverhältnisse: 1:1, 16:9, 9:16, 4:3, 3:4, 3:2, 2:3
  • Auflösungen: 480P, 720P
  • Dauer: 1-15 Sekunden für Generierung/Bild-zu-Video, 1-10 Sekunden bei Verwendung von reference_image-Rollen, 2-10 Sekunden für Erweiterung
  • Referenzbildgenerierung: Setzen Sie imageRoles für jedes bereitgestellte Bild auf reference_image; xAI akzeptiert bis zu 7 solcher Bilder
Lokale Videopuffer werden nicht akzeptiert. Verwenden Sie remote http(s)-URLs für Eingaben zur Video-Bearbeitung/-Erweiterung. Bild-zu-Video akzeptiert lokale Bildpuffer, da OpenClaw diese für xAI als Daten-URLs kodieren kann.
Um xAI als Standard-Video-Provider zu verwenden:
{
  agents: {
    defaults: {
      videoGenerationModel: {
        primary: "xai/grok-imagine-video",
      },
    },
  },
}
Siehe Videogenerierung für gemeinsame Tool-Parameter, Provider-Auswahl und Failover-Verhalten.
Das gebündelte xai-Plugin registriert Bildgenerierung über das gemeinsame image_generate-Tool.
  • Standard-Bildmodell: xai/grok-imagine-image
  • Zusätzliches Modell: xai/grok-imagine-image-pro
  • Modi: Text-zu-Bild und Referenzbild-Bearbeitung
  • Referenzeingaben: ein image oder bis zu fünf images
  • Seitenverhältnisse: 1:1, 16:9, 9:16, 4:3, 3:4, 2:3, 3:2
  • Auflösungen: 1K, 2K
  • Anzahl: bis zu 4 Bilder
OpenClaw fordert von xAI b64_json-Bildantworten an, damit generierte Medien über den normalen Kanal-Anhangspfad gespeichert und bereitgestellt werden können. Lokale Referenzbilder werden in Daten-URLs konvertiert; remote http(s)-Referenzen werden durchgereicht.Um xAI als Standard-Bild-Provider zu verwenden:
{
  agents: {
    defaults: {
      imageGenerationModel: {
        primary: "xai/grok-imagine-image",
      },
    },
  },
}
xAI dokumentiert außerdem quality, mask, user und zusätzliche native Seitenverhältnisse wie 1:2, 2:1, 9:20 und 20:9. OpenClaw leitet heute nur die gemeinsamen Provider-übergreifenden Bildsteuerungen weiter; nicht unterstützte, nur native Regler werden absichtlich nicht über image_generate bereitgestellt.
Das gebündelte xai-Plugin registriert Text-zu-Sprache über die gemeinsame tts-Provider-Oberfläche.
  • Stimmen: eve, ara, rex, sal, leo, una
  • Standardstimme: eve
  • Formate: mp3, wav, pcm, mulaw, alaw
  • Sprache: BCP-47-Code oder auto
  • Geschwindigkeit: Provider-native Geschwindigkeitsüberschreibung
  • Natives Opus-Sprachnotizformat wird nicht unterstützt
Um xAI als Standard-TTS-Provider zu verwenden:
{
  messages: {
    tts: {
      provider: "xai",
      providers: {
        xai: {
          voiceId: "eve",
        },
      },
    },
  },
}
OpenClaw verwendet den Batch-Endpunkt /v1/tts von xAI. xAI bietet auch Streaming-TTS über WebSocket an, aber der OpenClaw-Sprach-Provider-Vertrag erwartet derzeit einen vollständigen Audiopuffer vor der Antwortzustellung.
Das gebündelte xai-Plugin registriert Batch-Sprache-zu-Text über die Medienverständnis-Transkriptionsoberfläche von OpenClaw.
  • Standardmodell: grok-stt
  • Endpunkt: xAI REST /v1/stt
  • Eingabepfad: Multipart-Audiodatei-Upload
  • Unterstützt von OpenClaw überall dort, wo eingehende Audiotranskription tools.media.audio verwendet, einschließlich Discord-Sprachkanal-Segmenten und Kanal-Audioanhängen
Um xAI für eingehende Audiotranskription zu erzwingen:
{
  tools: {
    media: {
      audio: {
        models: [
          {
            type: "provider",
            provider: "xai",
            model: "grok-stt",
          },
        ],
      },
    },
  },
}
Die Sprache kann über die gemeinsame Audio-Medienkonfiguration oder pro Transkriptionsanfrage bereitgestellt werden. Prompt-Hinweise werden von der gemeinsamen OpenClaw-Oberfläche akzeptiert, aber die xAI-REST-STT-Integration leitet nur Datei, Modell und Sprache weiter, da diese sauber auf den aktuellen öffentlichen xAI-Endpunkt abbildbar sind.
Das gebündelte xai-Plugin registriert außerdem einen Echtzeit-Transkriptions-Provider für Live-Audio aus Sprachanrufen.
  • Endpunkt: xAI WebSocket wss://api.x.ai/v1/stt
  • Standardkodierung: mulaw
  • Standard-Abtastrate: 8000
  • Standard-Endpointerkennung: 800ms
  • Zwischen-Transkripte: standardmäßig aktiviert
Der Twilio-Medienstrom von Voice Call sendet G.711-µ-law-Audioframes, sodass der xAI-Provider diese Frames direkt ohne Transkodierung weiterleiten kann:
{
  plugins: {
    entries: {
      "voice-call": {
        config: {
          streaming: {
            enabled: true,
            provider: "xai",
            providers: {
              xai: {
                apiKey: "${XAI_API_KEY}",
                endpointingMs: 800,
                language: "en",
              },
            },
          },
        },
      },
    },
  },
}
Provider-eigene Konfiguration befindet sich unter plugins.entries.voice-call.config.streaming.providers.xai. Unterstützte Schlüssel sind apiKey, baseUrl, sampleRate, encoding (pcm, mulaw oder alaw), interimResults, endpointingMs und language.
Dieser Streaming-Provider ist für den Echtzeit-Transkriptionspfad von Voice Call vorgesehen. Discord-Voice zeichnet derzeit kurze Segmente auf und verwendet stattdessen den Batch-Transkriptionspfad tools.media.audio.
Das gebündelte xAI-Plugin stellt x_search als OpenClaw-Tool zum Durchsuchen von X-Inhalten (ehemals Twitter) über Grok bereit.Konfigurationspfad: plugins.entries.xai.config.xSearch
SchlüsselTypStandardwertBeschreibung
enabledboolean-x_search aktivieren oder deaktivieren
modelstringgrok-4-1-fastFür x_search-Anfragen verwendetes Modell
baseUrlstring-Überschreibung der xAI Responses-Basis-URL
inlineCitationsboolean-Inline-Zitationen in Ergebnisse aufnehmen
maxTurnsnumber-Maximale Anzahl an Konversationsturns
timeoutSecondsnumber-Anfrage-Timeout in Sekunden
cacheTtlMinutesnumber-Cache-Lebensdauer in Minuten
{
  plugins: {
    entries: {
      xai: {
        config: {
          xSearch: {
            enabled: true,
            model: "grok-4-1-fast",
            baseUrl: "https://api.x.ai/v1",
            inlineCitations: true,
          },
        },
      },
    },
  },
}
Das gebündelte xAI-Plugin stellt code_execution als OpenClaw-Tool für Remote-Codeausführung in der Sandbox-Umgebung von xAI bereit.Konfigurationspfad: plugins.entries.xai.config.codeExecution
SchlüsselTypStandardwertBeschreibung
enabledbooleantrue (wenn Schlüssel verfügbar)Codeausführung aktivieren oder deaktivieren
modelstringgrok-4-1-fastFür Codeausführungsanfragen verwendetes Modell
maxTurnsnumber-Maximale Anzahl an Konversationsturns
timeoutSecondsnumber-Anfrage-Timeout in Sekunden
Dies ist Remote-Ausführung in der xAI-Sandbox, nicht lokales exec.
{
  plugins: {
    entries: {
      xai: {
        config: {
          codeExecution: {
            enabled: true,
            model: "grok-4-1-fast",
          },
        },
      },
    },
  },
}
  • Authentifizierung erfolgt heute nur per API-Schlüssel. Der API-Schlüssel kann in einem xAI-Auth- Profil, einer Umgebungsvariable oder der Plugin-Konfiguration gespeichert werden; es gibt in OpenClaw noch keinen xAI-OAuth- oder Device-Code-Flow.
  • grok-4.20-multi-agent-experimental-beta-0304 wird auf dem normalen xAI-Provider-Pfad nicht unterstützt, weil es eine andere Upstream-API- Oberfläche benötigt als der standardmäßige OpenClaw-xAI-Transport.
  • xAI Realtime Voice ist noch nicht als OpenClaw-Provider registriert. Es benötigt einen anderen bidirektionalen Voice-Session-Vertrag als Batch-STT oder Streaming-Transkription.
  • xAI-Bild-quality, Bild-mask und zusätzliche nur native Seitenverhältnisse werden erst offengelegt, wenn das gemeinsame image_generate-Tool entsprechende providerübergreifende Steuerelemente hat.
  • OpenClaw wendet xAI-spezifische Kompatibilitätskorrekturen für Tool-Schemas und Tool-Aufrufe automatisch auf dem gemeinsamen Runner-Pfad an.
  • Native xAI-Anfragen verwenden standardmäßig tool_stream: true. Setzen Sie agents.defaults.models["xai/<model>"].params.tool_stream auf false, um dies zu deaktivieren.
  • Der gebündelte xAI-Wrapper entfernt nicht unterstützte Strict-Tool-Schema-Flags und Reasoning-Payload-Schlüssel, bevor native xAI-Anfragen gesendet werden.
  • web_search, x_search und code_execution werden als OpenClaw- Tools offengelegt. OpenClaw aktiviert das jeweils benötigte spezifische integrierte xAI-Tool innerhalb jeder Tool-Anfrage, statt alle nativen Tools an jeden Chat-Turn anzuhängen.
  • Grok web_search liest plugins.entries.xai.config.webSearch.baseUrl. x_search liest plugins.entries.xai.config.xSearch.baseUrl und fällt dann auf die Grok-Web-Search-Basis-URL zurück.
  • x_search und code_execution gehören zum gebündelten xAI-Plugin und sind nicht fest in die Core-Modelllaufzeit codiert.
  • code_execution ist Remote-Ausführung in der xAI-Sandbox, nicht lokales exec.

Live-Tests

Die xAI-Medienpfade werden durch Unit-Tests und Opt-in-Live-Suites abgedeckt. Die Live- Befehle laden Secrets aus Ihrer Login-Shell, einschließlich ~/.profile, bevor sie XAI_API_KEY prüfen.
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
Die providerspezifische Live-Datei synthetisiert normales TTS, telefoniefreundliches PCM- TTS, transkribiert Audio über xAI Batch-STT, streamt dasselbe PCM über xAI Realtime-STT, generiert Text-zu-Bild-Ausgabe und bearbeitet ein Referenzbild. Die gemeinsame Image-Live-Datei verifiziert denselben xAI-Provider über OpenClaws Laufzeitauswahl, Fallback, Normalisierung und Medienanhangspfad.

Verwandt

Modellauswahl

Provider, Modellreferenzen und Failover-Verhalten auswählen.

Videogenerierung

Gemeinsame Videotool-Parameter und Provider-Auswahl.

Alle Provider

Die umfassendere Provider-Übersicht.

Fehlerbehebung

Häufige Probleme und Korrekturen.