Providers

xAI

OpenClaw levert een meegeleverde xai provider-Plugin voor Grok-modellen.

Aan de slag

  • Maak een API-sleutel

    Maak een API-sleutel aan in de xAI-console.

  • Stel je API-sleutel in

    Stel XAI_API_KEY in, of voer uit:

    bash
    openclaw onboard --auth-choice xai-api-key
  • Kies een model

    json5
    {  agents: { defaults: { model: { primary: "xai/grok-4.3" } } },}
  • Ingebouwde catalogus

    OpenClaw bevat standaard deze xAI-modelfamilies:

    Familie Model-id's
    Grok 3 grok-3, grok-3-fast, grok-3-mini, grok-3-mini-fast
    Grok 4.3 grok-4.3
    Grok 4 grok-4, grok-4-0709
    Grok 4 Fast grok-4-fast, grok-4-fast-non-reasoning
    Grok 4.1 Fast grok-4-1-fast, grok-4-1-fast-non-reasoning
    Grok 4.20 Beta grok-4.20-beta-latest-reasoning, grok-4.20-beta-latest-non-reasoning
    Grok Code grok-code-fast-1

    De Plugin lost ook nieuwere grok-4*- en grok-code-fast*-id's voorwaarts op wanneer ze dezelfde API-vorm volgen.

    OpenClaw-functiedekking

    De meegeleverde Plugin koppelt het huidige openbare API-oppervlak van xAI aan de gedeelde provider- en toolcontracten van OpenClaw. Mogelijkheden die niet in het gedeelde contract passen (bijvoorbeeld streaming-TTS en realtime spraak) worden niet beschikbaar gemaakt - zie de tabel hieronder.

    xAI-mogelijkheid OpenClaw-oppervlak Status
    Chat / Responses xai/<model> modelprovider Ja
    Webzoekopdracht aan serverzijde web_search provider grok Ja
    X-zoekopdracht aan serverzijde x_search tool Ja
    Code-uitvoering aan serverzijde code_execution tool Ja
    Afbeeldingen image_generate Ja
    Video's video_generate Ja
    Batch tekst-naar-spraak messages.tts.provider: "xai" / tts Ja
    Streaming-TTS - Niet beschikbaar gemaakt; OpenClaw's TTS-contract retourneert volledige audiobuffers
    Batch spraak-naar-tekst tools.media.audio / mediabegrip Ja
    Streaming spraak-naar-tekst Voice Call streaming.provider: "xai" Ja
    Realtime spraak - Nog niet beschikbaar gemaakt; ander sessie-/WebSocket-contract
    Bestanden / batches Alleen generieke model-API-compatibiliteit Geen eersteklas OpenClaw-tool

    Fast-modus-toewijzingen

    /fast on of agents.defaults.models["xai/<model>"].params.fastMode: true herschrijft native xAI-verzoeken als volgt:

    Bronmodel Fast-modus-doel
    grok-3 grok-3-fast
    grok-3-mini grok-3-mini-fast
    grok-4 grok-4-fast
    grok-4-0709 grok-4-fast

    Legacy-compatibiliteitsaliassen

    Legacy-aliassen normaliseren nog steeds naar de canonieke meegeleverde id's:

    Legacy-alias Canonieke id
    grok-4-fast-reasoning grok-4-fast
    grok-4-1-fast-reasoning grok-4-1-fast
    grok-4.20-reasoning grok-4.20-beta-latest-reasoning
    grok-4.20-non-reasoning grok-4.20-beta-latest-non-reasoning

    Functies

    Webzoekopdracht

    De meegeleverde grok webzoekprovider kan XAI_API_KEY of een Plugin- webzoeksleutel gebruiken:

    bash
    openclaw config set tools.web.search.provider grok
    Videogeneratie

    De meegeleverde xai-Plugin registreert videogeneratie via de gedeelde video_generate tool.

    • Standaard videomodel: xai/grok-imagine-video
    • Modi: tekst-naar-video, afbeelding-naar-video, generatie met referentieafbeelding, externe videobewerking en externe video-uitbreiding
    • Beeldverhoudingen: 1:1, 16:9, 9:16, 4:3, 3:4, 3:2, 2:3
    • Resoluties: 480P, 720P
    • Duur: 1-15 seconden voor generatie/afbeelding-naar-video, 1-10 seconden bij gebruik van reference_image-rollen, 2-10 seconden voor uitbreiding
    • Generatie met referentieafbeelding: stel imageRoles in op reference_image voor elke meegeleverde afbeelding; xAI accepteert maximaal 7 zulke afbeeldingen

    Om xAI als standaard videoprovider te gebruiken:

    json5
    {  agents: {    defaults: {      videoGenerationModel: {        primary: "xai/grok-imagine-video",      },    },  },}
    Afbeeldingsgeneratie

    De meegeleverde xai-Plugin registreert afbeeldingsgeneratie via de gedeelde image_generate tool.

    • Standaard afbeeldingsmodel: xai/grok-imagine-image
    • Aanvullend model: xai/grok-imagine-image-pro
    • Modi: tekst-naar-afbeelding en bewerken met referentieafbeelding
    • Referentie-invoer: één image of maximaal vijf images
    • Beeldverhoudingen: 1:1, 16:9, 9:16, 4:3, 3:4, 2:3, 3:2
    • Resoluties: 1K, 2K
    • Aantal: maximaal 4 afbeeldingen

    OpenClaw vraagt xAI om b64_json afbeeldingsreacties zodat gegenereerde media kunnen worden opgeslagen en geleverd via het normale pad voor kanaalbijlagen. Lokale referentieafbeeldingen worden omgezet naar data-URL's; externe http(s)-referenties worden doorgegeven.

    Om xAI als standaard afbeeldingsprovider te gebruiken:

    json5
    {  agents: {    defaults: {      imageGenerationModel: {        primary: "xai/grok-imagine-image",      },    },  },}
    Tekst-naar-spraak

    De meegeleverde xai-Plugin registreert tekst-naar-spraak via het gedeelde tts provideroppervlak.

    • Stemmen: eve, ara, rex, sal, leo, una
    • Standaardstem: eve
    • Formaten: mp3, wav, pcm, mulaw, alaw
    • Taal: BCP-47-code of auto
    • Snelheid: provider-native snelheidsoverschrijving
    • Native Opus-spraaknotitieformaat wordt niet ondersteund

    Om xAI als standaard TTS-provider te gebruiken:

    json5
    {  messages: {    tts: {      provider: "xai",      providers: {        xai: {          voiceId: "eve",        },      },    },  },}
    Spraak-naar-tekst

    De meegeleverde xai-Plugin registreert batch spraak-naar-tekst via OpenClaw's transcriptieoppervlak voor mediabegrip.

    • Standaardmodel: grok-stt
    • Endpoint: xAI REST /v1/stt
    • Invoerpad: upload van multipart-audiobestand
    • Ondersteund door OpenClaw overal waar transcriptie van inkomende audio tools.media.audio gebruikt, inclusief Discord-spraakkanaalsegmenten en audiobijlagen van kanalen

    Om xAI af te dwingen voor transcriptie van inkomende audio:

    json5
    {  tools: {    media: {      audio: {        models: [          {            type: "provider",            provider: "xai",            model: "grok-stt",          },        ],      },    },  },}

    Taal kan worden opgegeven via de gedeelde audiomediaconfiguratie of per-call transcriptieverzoek. Prompt-hints worden geaccepteerd door het gedeelde OpenClaw- oppervlak, maar de xAI REST STT-integratie stuurt alleen bestand, model en taal door omdat die netjes aansluiten op het huidige openbare xAI-endpoint.

    Streaming spraak-naar-tekst

    De meegeleverde xai-Plugin registreert ook een realtime transcriptieprovider voor live spraakoproepaudio.

    • Endpoint: xAI WebSocket wss://api.x.ai/v1/stt
    • Standaardcodering: mulaw
    • Standaard samplefrequentie: 8000
    • Standaard endpointing: 800ms
    • Tussentijdse transcripties: standaard ingeschakeld

    De Twilio-mediastream van Voice Call verzendt G.711 µ-law-audioframes, zodat de xAI-provider die frames rechtstreeks kan doorsturen zonder transcoding:

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

    Config in eigendom van de provider staat onder plugins.entries.voice-call.config.streaming.providers.xai. Ondersteunde sleutels zijn apiKey, baseUrl, sampleRate, encoding (pcm, mulaw of alaw), interimResults, endpointingMs en language.

    x_search-configuratie

    De gebundelde xAI-Plugin stelt x_search beschikbaar als een OpenClaw-tool voor het doorzoeken van X-content (voorheen Twitter) via Grok.

    Configuratiepad: plugins.entries.xai.config.xSearch

    Sleutel Type Standaard Beschrijving
    enabled boolean - Schakel x_search in of uit
    model string grok-4-1-fast Model dat wordt gebruikt voor x_search-aanvragen
    baseUrl string - Overschrijving van de xAI Responses-basis-URL
    inlineCitations boolean - Inline citaties opnemen in resultaten
    maxTurns number - Maximumaantal gespreksbeurten
    timeoutSeconds number - Aanvraagtime-out in seconden
    cacheTtlMinutes number - Cache-time-to-live in minuten
    json5
    {  plugins: {    entries: {      xai: {        config: {          xSearch: {            enabled: true,            model: "grok-4-1-fast",            baseUrl: "https://api.x.ai/v1",            inlineCitations: true,          },        },      },    },  },}
    Configuratie voor code-uitvoering

    De gebundelde xAI-Plugin stelt code_execution beschikbaar als een OpenClaw-tool voor externe code-uitvoering in de sandboxomgeving van xAI.

    Configuratiepad: plugins.entries.xai.config.codeExecution

    Sleutel Type Standaard Beschrijving
    enabled boolean true (als sleutel beschikbaar is) Schakel code-uitvoering in of uit
    model string grok-4-1-fast Model dat wordt gebruikt voor code-uitvoeringsaanvragen
    maxTurns number - Maximumaantal gespreksbeurten
    timeoutSeconds number - Aanvraagtime-out in seconden
    json5
    {  plugins: {    entries: {      xai: {        config: {          codeExecution: {            enabled: true,            model: "grok-4-1-fast",          },        },      },    },  },}
    Bekende beperkingen
    • Auth is vandaag alleen API-sleutelgebaseerd. De API-sleutel kan worden opgeslagen in een xAI-authprofiel, omgevingsvariabele of Plugin-configuratie; er is nog geen xAI OAuth- of device-code-flow in OpenClaw.
    • grok-4.20-multi-agent-experimental-beta-0304 wordt niet ondersteund op het normale xAI-providerpad, omdat het een ander upstream-API-oppervlak vereist dan het standaard OpenClaw xAI-transport.
    • xAI Realtime-spraak is nog niet geregistreerd als OpenClaw-provider. Het vereist een ander bidirectioneel spraaksessiecontract dan batch-STT of streamingtranscriptie.
    • xAI-afbeeldingsquality, afbeeldingsmask en extra uitsluitend-native beeldverhoudingen worden niet beschikbaar gesteld totdat de gedeelde image_generate-tool bijbehorende provideroverschrijdende besturingselementen heeft.
    Geavanceerde opmerkingen
    • OpenClaw past automatisch xAI-specifieke compatibiliteitsfixes voor toolschema's en toolaanroepen toe op het gedeelde runnerpad.
    • Native xAI-aanvragen gebruiken standaard tool_stream: true. Stel agents.defaults.models["xai/<model>"].params.tool_stream in op false om dit uit te schakelen.
    • De gebundelde xAI-wrapper verwijdert niet-ondersteunde strikte toolschema-vlaggen en reasoning-payloadsleutels voordat native xAI-aanvragen worden verzonden.
    • web_search, x_search en code_execution worden beschikbaar gesteld als OpenClaw- tools. OpenClaw schakelt de specifieke ingebouwde xAI-functionaliteit die het nodig heeft in binnen elke tool- aanvraag, in plaats van alle native tools aan elke chatbeurt te koppelen.
    • Grok web_search leest plugins.entries.xai.config.webSearch.baseUrl. x_search leest plugins.entries.xai.config.xSearch.baseUrl en valt daarna terug op de Grok web-search-basis-URL.
    • x_search en code_execution zijn eigendom van de gebundelde xAI-Plugin in plaats van hardcoded in de core modelruntime.
    • code_execution is externe xAI-sandboxuitvoering, geen lokale exec.

    Live testen

    De xAI-mediapaden worden gedekt door unittests en opt-in live suites. De live commando's laden geheimen uit je login-shell, inclusief ~/.profile, voordat XAI_API_KEY wordt onderzocht.

    bash
    pnpm test extensions/xaiOPENCLAW_LIVE_TEST=1 OPENCLAW_LIVE_TEST_QUIET=1 pnpm test:live -- extensions/xai/xai.live.test.tsOPENCLAW_LIVE_TEST=1 OPENCLAW_LIVE_TEST_QUIET=1 OPENCLAW_LIVE_IMAGE_GENERATION_PROVIDERS=xai pnpm test:live -- test/image-generation.runtime.live.test.ts

    Het providerspecifieke live bestand synthetiseert normale TTS, telefonievriendelijke PCM- TTS, transcribeert audio via xAI batch-STT, streamt dezelfde PCM via xAI realtime STT, genereert tekst-naar-afbeelding-uitvoer en bewerkt een referentieafbeelding. Het gedeelde live afbeeldingsbestand verifieert dezelfde xAI-provider via OpenClaw's runtimeselectie, fallback, normalisatie en media-attachmentpad.

    Gerelateerd

    Was this useful?