Providers

xAI

O OpenClaw inclui um plugin de provedor xai integrado para modelos Grok.

Primeiros passos

  • Crie uma chave de API

    Crie uma chave de API no console da xAI.

  • Defina sua chave de API

    Defina XAI_API_KEY ou execute:

    bash
    openclaw onboard --auth-choice xai-api-key
  • Escolha um modelo

    json5
    {  agents: { defaults: { model: { primary: "xai/grok-4.3" } } },}
  • Catálogo integrado

    O OpenClaw inclui estas famílias de modelos xAI prontas para uso:

    Família IDs de modelo
    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

    O plugin também resolve adiante IDs grok-4* e grok-code-fast* mais recentes quando eles seguem o mesmo formato de API.

    Cobertura de recursos do OpenClaw

    O plugin integrado mapeia a superfície atual da API pública da xAI para os contratos compartilhados de provedor e ferramentas do OpenClaw. Capacidades que não se encaixam no contrato compartilhado (por exemplo, TTS por streaming e voz em tempo real) não são expostas - veja a tabela abaixo.

    Capacidade da xAI Superfície do OpenClaw Status
    Chat / Responses Provedor de modelo xai/<model> Sim
    Busca na web no servidor Provedor web_search grok Sim
    Busca X no servidor Ferramenta x_search Sim
    Execução de código no servidor Ferramenta code_execution Sim
    Imagens image_generate Sim
    Vídeos video_generate Sim
    Texto para fala em lote messages.tts.provider: "xai" / tts Sim
    TTS por streaming - Não exposto; o contrato de TTS do OpenClaw retorna buffers de áudio completos
    Fala para texto em lote tools.media.audio / compreensão de mídia Sim
    Fala para texto por streaming Voice Call streaming.provider: "xai" Sim
    Voz em tempo real - Ainda não exposto; contrato de sessão/WebSocket diferente
    Arquivos / lotes Compatibilidade apenas com API genérica de modelo Não é uma ferramenta OpenClaw de primeira classe

    Mapeamentos de modo rápido

    /fast on ou agents.defaults.models["xai/<model>"].params.fastMode: true reescreve solicitações xAI nativas da seguinte forma:

    Modelo de origem Destino do modo rápido
    grok-3 grok-3-fast
    grok-3-mini grok-3-mini-fast
    grok-4 grok-4-fast
    grok-4-0709 grok-4-fast

    Aliases de compatibilidade legados

    Aliases legados ainda são normalizados para os IDs integrados canônicos:

    Alias legado ID canônico
    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

    Recursos

    Busca na web

    O provedor de busca na web grok integrado pode usar XAI_API_KEY ou uma chave de busca na web do plugin:

    bash
    openclaw config set tools.web.search.provider grok
    Geração de vídeo

    O plugin xai integrado registra a geração de vídeo por meio da ferramenta compartilhada video_generate.

    • Modelo de vídeo padrão: xai/grok-imagine-video
    • Modos: texto para vídeo, imagem para vídeo, geração por imagem de referência, edição de vídeo remota e extensão de vídeo remota
    • Proporções de tela: 1:1, 16:9, 9:16, 4:3, 3:4, 3:2, 2:3
    • Resoluções: 480P, 720P
    • Duração: 1-15 segundos para geração/imagem para vídeo, 1-10 segundos ao usar funções reference_image, 2-10 segundos para extensão
    • Geração por imagem de referência: defina imageRoles como reference_image para cada imagem fornecida; a xAI aceita até 7 dessas imagens

    Para usar xAI como o provedor de vídeo padrão:

    json5
    {  agents: {    defaults: {      videoGenerationModel: {        primary: "xai/grok-imagine-video",      },    },  },}
    Geração de imagem

    O plugin xai integrado registra a geração de imagem por meio da ferramenta compartilhada image_generate.

    • Modelo de imagem padrão: xai/grok-imagine-image
    • Modelo adicional: xai/grok-imagine-image-pro
    • Modos: texto para imagem e edição por imagem de referência
    • Entradas de referência: uma image ou até cinco images
    • Proporções de tela: 1:1, 16:9, 9:16, 4:3, 3:4, 2:3, 3:2
    • Resoluções: 1K, 2K
    • Quantidade: até 4 imagens

    O OpenClaw solicita à xAI respostas de imagem b64_json para que a mídia gerada possa ser armazenada e entregue pelo caminho normal de anexos do canal. Imagens de referência locais são convertidas em URLs de dados; referências remotas http(s) são repassadas.

    Para usar xAI como o provedor de imagem padrão:

    json5
    {  agents: {    defaults: {      imageGenerationModel: {        primary: "xai/grok-imagine-image",      },    },  },}
    Texto para fala

    O plugin xai integrado registra texto para fala por meio da superfície compartilhada do provedor tts.

    • Vozes: eve, ara, rex, sal, leo, una
    • Voz padrão: eve
    • Formatos: mp3, wav, pcm, mulaw, alaw
    • Idioma: código BCP-47 ou auto
    • Velocidade: substituição de velocidade nativa do provedor
    • O formato nativo de nota de voz Opus não é compatível

    Para usar xAI como o provedor de TTS padrão:

    json5
    {  messages: {    tts: {      provider: "xai",      providers: {        xai: {          voiceId: "eve",        },      },    },  },}
    Fala para texto

    O plugin xai integrado registra fala para texto em lote por meio da superfície de transcrição de compreensão de mídia do OpenClaw.

    • Modelo padrão: grok-stt
    • Endpoint: REST da xAI /v1/stt
    • Caminho de entrada: upload de arquivo de áudio multipart
    • Compatível com o OpenClaw sempre que a transcrição de áudio de entrada usa tools.media.audio, incluindo segmentos de canais de voz do Discord e anexos de áudio de canal

    Para forçar xAI para transcrição de áudio de entrada:

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

    O idioma pode ser fornecido pela configuração compartilhada de mídia de áudio ou por solicitação de transcrição por chamada. Dicas de prompt são aceitas pela superfície compartilhada do OpenClaw, mas a integração REST STT da xAI encaminha apenas arquivo, modelo e idioma porque eles mapeiam claramente para o endpoint público atual da xAI.

    Fala para texto por streaming

    O plugin xai integrado também registra um provedor de transcrição em tempo real para áudio de chamadas de voz ao vivo.

    • Endpoint: WebSocket da xAI wss://api.x.ai/v1/stt
    • Codificação padrão: mulaw
    • Taxa de amostragem padrão: 8000
    • Endpointing padrão: 800ms
    • Transcrições intermediárias: ativadas por padrão

    O fluxo de mídia Twilio do Voice Call envia quadros de áudio G.711 µ-law, então o provedor xAI pode encaminhar esses quadros diretamente sem transcodificação:

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

    A configuração pertencente ao provedor fica em plugins.entries.voice-call.config.streaming.providers.xai. As chaves compatíveis são apiKey, baseUrl, sampleRate, encoding (pcm, mulaw ou alaw), interimResults, endpointingMs e language.

    Configuração do x_search

    O Plugin xAI incluído expõe x_search como uma ferramenta do OpenClaw para pesquisar conteúdo do X (antigo Twitter) via Grok.

    Caminho de configuração: plugins.entries.xai.config.xSearch

    Chave Tipo Padrão Descrição
    enabled boolean - Ativar ou desativar x_search
    model string grok-4-1-fast Modelo usado para solicitações x_search
    baseUrl string - Substituição da URL base do xAI Responses
    inlineCitations boolean - Incluir citações em linha nos resultados
    maxTurns number - Máximo de turnos de conversa
    timeoutSeconds number - Tempo limite da solicitação em segundos
    cacheTtlMinutes number - Tempo de vida do cache em minutos
    json5
    {  plugins: {    entries: {      xai: {        config: {          xSearch: {            enabled: true,            model: "grok-4-1-fast",            baseUrl: "https://api.x.ai/v1",            inlineCitations: true,          },        },      },    },  },}
    Configuração de execução de código

    O Plugin xAI incluído expõe code_execution como uma ferramenta do OpenClaw para execução remota de código no ambiente sandbox da xAI.

    Caminho de configuração: plugins.entries.xai.config.codeExecution

    Chave Tipo Padrão Descrição
    enabled boolean true (se a chave estiver disponível) Ativar ou desativar a execução de código
    model string grok-4-1-fast Modelo usado para solicitações de execução de código
    maxTurns number - Máximo de turnos de conversa
    timeoutSeconds number - Tempo limite da solicitação em segundos
    json5
    {  plugins: {    entries: {      xai: {        config: {          codeExecution: {            enabled: true,            model: "grok-4-1-fast",          },        },      },    },  },}
    Limites conhecidos
    • Hoje, a autenticação é somente por chave de API. A chave de API pode ser armazenada em um perfil de autenticação da xAI, variável de ambiente ou configuração do Plugin; ainda não há fluxo OAuth da xAI nem fluxo de código de dispositivo no OpenClaw.
    • grok-4.20-multi-agent-experimental-beta-0304 não é compatível com o caminho normal do provedor xAI porque exige uma superfície de API upstream diferente do transporte xAI padrão do OpenClaw.
    • A voz xAI Realtime ainda não está registrada como um provedor do OpenClaw. Ela precisa de um contrato de sessão de voz bidirecional diferente de STT em lote ou transcrição por streaming.
    • quality de imagem da xAI, mask de imagem e proporções extras somente nativas não são expostas até que a ferramenta compartilhada image_generate tenha controles correspondentes entre provedores.
    Observações avançadas
    • O OpenClaw aplica correções de compatibilidade de esquema de ferramentas e chamadas de ferramentas específicas da xAI automaticamente no caminho do runner compartilhado.
    • As solicitações nativas da xAI usam tool_stream: true por padrão. Defina agents.defaults.models["xai/<model>"].params.tool_stream como false para desativar.
    • O wrapper xAI incluído remove flags de esquema de ferramentas estritas sem suporte e chaves de payload de raciocínio antes de enviar solicitações nativas da xAI.
    • web_search, x_search e code_execution são expostos como ferramentas do OpenClaw. O OpenClaw habilita o recurso integrado específico da xAI de que precisa dentro de cada solicitação de ferramenta, em vez de anexar todas as ferramentas nativas a cada turno de chat.
    • O web_search do Grok lê plugins.entries.xai.config.webSearch.baseUrl. x_searchplugins.entries.xai.config.xSearch.baseUrl e depois recorre à URL base da pesquisa web do Grok.
    • x_search e code_execution pertencem ao Plugin xAI incluído, em vez de serem codificados diretamente no runtime principal de modelos.
    • code_execution é execução remota no sandbox da xAI, não exec local.

    Testes ao vivo

    Os caminhos de mídia da xAI são cobertos por testes unitários e suítes ao vivo opcionais. Os comandos ao vivo carregam segredos do seu shell de login, incluindo ~/.profile, antes de verificar XAI_API_KEY.

    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

    O arquivo ao vivo específico do provedor sintetiza TTS normal, TTS PCM adequado para telefonia, transcreve áudio por STT em lote da xAI, transmite o mesmo PCM por STT em tempo real da xAI, gera saída de texto para imagem e edita uma imagem de referência. O arquivo ao vivo de imagem compartilhada verifica o mesmo provedor xAI pelo caminho de seleção de runtime, fallback, normalização e anexo de mídia do OpenClaw.

    Relacionados

    Was this useful?