Перейти до основного вмісту

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 постачається з вбудованим Plugin провайдера xai для моделей Grok.

​
Початок роботи

1

Створіть API-ключ

Створіть API-ключ у консолі xAI.
2

Налаштуйте свій API-ключ

Налаштуйте XAI_API_KEY або виконайте:
openclaw onboard --auth-choice xai-api-key
3

Виберіть модель

{
  agents: { defaults: { model: { primary: "xai/grok-4.3" } } },
}
OpenClaw використовує xAI Responses API як вбудований транспорт xAI. Той самий API-ключ з openclaw onboard --auth-choice xai-api-key також може живити першокласні x_search і віддалений code_execution; XAI_API_KEY або конфігурація вебпошуку Plugin також може живити web_search на базі Grok. Якщо ви зберігаєте ключ xAI у plugins.entries.xai.config.webSearch.apiKey, вбудований провайдер моделей xAI також повторно використовує цей ключ як резервний. Налаштуйте plugins.entries.xai.config.webSearch.baseUrl, щоб спрямовувати Grok web_search і, типово, x_search через операторський проксі xAI Responses. Налаштування code_execution розміщені в plugins.entries.xai.config.codeExecution.

​
Вбудований каталог

OpenClaw одразу містить такі сімейства моделей xAI:
СімействоІдентифікатори моделей
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
Plugin також наперед розв’язує новіші ідентифікатори grok-4* і grok-code-fast*, коли вони мають ту саму форму API.
grok-4.3, grok-4-fast, grok-4-1-fast і варіанти grok-4.20-beta-* є поточними посиланнями Grok із підтримкою зображень у вбудованому каталозі.

​
Покриття функцій OpenClaw

Вбудований Plugin відображає поточну публічну поверхню API xAI на спільні контракти провайдера та інструментів OpenClaw. Можливості, що не відповідають спільному контракту (наприклад потоковий TTS і голос у реальному часі), не експонуються - див. таблицю нижче.
Можливість xAIПоверхня OpenClawСтатус
Чат / Responsesпровайдер моделей xai/<model>Так
Серверний вебпошукпровайдер web_search grokТак
Серверний пошук Xінструмент x_searchТак
Серверне виконання кодуінструмент code_executionТак
Зображенняimage_generateТак
Відеоvideo_generateТак
Пакетний text-to-speechmessages.tts.provider: "xai" / ttsТак
Потоковий TTS-Не експонується; контракт TTS OpenClaw повертає повні аудіобуфери
Пакетний speech-to-texttools.media.audio / розуміння медіаТак
Потоковий speech-to-textVoice Call streaming.provider: "xai"Так
Голос у реальному часі-Ще не експонується; інший контракт сеансу/WebSocket
Файли / пакетиЛише сумісність із загальним API моделейНе є першокласним інструментом OpenClaw
OpenClaw використовує REST API xAI для зображень/відео/TTS/STT для генерації медіа, мовлення та пакетної транскрипції, потоковий STT WebSocket xAI для живої транскрипції голосових викликів і Responses API для інструментів моделей, пошуку та виконання коду. Функції, яким потрібні інші контракти OpenClaw, як-от сеанси голосу в реальному часі, задокументовані тут як можливості upstream, а не як прихована поведінка Plugin.

​
Відображення швидкого режиму

/fast on або agents.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

​
Застарілі псевдоніми сумісності

Застарілі псевдоніми й далі нормалізуються до канонічних вбудованих ідентифікаторів:
Застарілий псевдонімКанонічний ідентифікатор
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

​
Функції

Вбудований провайдер вебпошуку grok може використовувати XAI_API_KEY або ключ вебпошуку Plugin:
openclaw config set tools.web.search.provider grok
Вбудований Plugin xai реєструє генерацію відео через спільний інструмент video_generate.
  • Стандартна модель відео: xai/grok-imagine-video
  • Режими: текст-у-відео, зображення-у-відео, генерація за референсним зображенням, віддалене редагування відео та віддалене розширення відео
  • Співвідношення сторін: 1:1, 16:9, 9:16, 4:3, 3:4, 3:2, 2:3
  • Роздільні здатності: 480P, 720P
  • Тривалість: 1-15 секунд для генерації/зображення-у-відео, 1-10 секунд під час використання ролей reference_image, 2-10 секунд для розширення
  • Генерація за референсним зображенням: задайте imageRoles як reference_image для кожного наданого зображення; xAI приймає до 7 таких зображень
Локальні відеобуфери не приймаються. Використовуйте віддалені URL http(s) для вхідних даних редагування/розширення відео. Зображення-у-відео приймає локальні буфери зображень, бо OpenClaw може закодувати їх як data URL для xAI.
Щоб використовувати xAI як стандартного провайдера відео:
{
  agents: {
    defaults: {
      videoGenerationModel: {
        primary: "xai/grok-imagine-video",
      },
    },
  },
}
Див. Генерація відео щодо спільних параметрів інструмента, вибору провайдера та поведінки failover.
Вбудований Plugin xai реєструє генерацію зображень через спільний інструмент image_generate.
  • Стандартна модель зображень: xai/grok-imagine-image
  • Додаткова модель: xai/grok-imagine-image-pro
  • Режими: текст-у-зображення та редагування за референсним зображенням
  • Референсні вхідні дані: одне image або до п’яти images
  • Співвідношення сторін: 1:1, 16:9, 9:16, 4:3, 3:4, 2:3, 3:2
  • Роздільні здатності: 1K, 2K
  • Кількість: до 4 зображень
OpenClaw запитує в xAI відповіді зображень b64_json, щоб згенеровані медіа можна було зберігати й доставляти через звичайний шлях вкладень каналу. Локальні референсні зображення перетворюються на data URL; віддалені референси http(s) передаються напряму.Щоб використовувати xAI як стандартного провайдера зображень:
{
  agents: {
    defaults: {
      imageGenerationModel: {
        primary: "xai/grok-imagine-image",
      },
    },
  },
}
xAI також документує quality, mask, user і додаткові нативні співвідношення, як-от 1:2, 2:1, 9:20 і 20:9. Наразі OpenClaw передає лише спільні міжпровайдерні елементи керування зображеннями; непідтримувані нативні параметри навмисно не експонуються через image_generate.
Вбудований Plugin xai реєструє text-to-speech через спільну поверхню провайдера tts.
  • Голоси: eve, ara, rex, sal, leo, una
  • Стандартний голос: eve
  • Формати: mp3, wav, pcm, mulaw, alaw
  • Мова: код BCP-47 або auto
  • Швидкість: нативне перевизначення швидкості провайдера
  • Нативний формат голосових нотаток Opus не підтримується
Щоб використовувати xAI як стандартного провайдера TTS:
{
  messages: {
    tts: {
      provider: "xai",
      providers: {
        xai: {
          voiceId: "eve",
        },
      },
    },
  },
}
OpenClaw використовує пакетний endpoint xAI /v1/tts. xAI також пропонує потоковий TTS через WebSocket, але контракт провайдера мовлення OpenClaw наразі очікує повний аудіобуфер перед доставленням відповіді.
Вбудований Plugin xai реєструє пакетний speech-to-text через поверхню транскрипції розуміння медіа OpenClaw.
  • Стандартна модель: grok-stt
  • Endpoint: xAI REST /v1/stt
  • Шлях введення: завантаження multipart-аудіофайлу
  • Підтримується OpenClaw усюди, де транскрипція вхідного аудіо використовує tools.media.audio, включно із сегментами голосових каналів Discord і аудіовкладеннями каналів
Щоб примусово використовувати xAI для транскрипції вхідного аудіо:
{
  tools: {
    media: {
      audio: {
        models: [
          {
            type: "provider",
            provider: "xai",
            model: "grok-stt",
          },
        ],
      },
    },
  },
}
Мову можна надати через спільну конфігурацію аудіомедіа або в запиті транскрипції для окремого виклику. Підказки prompt приймаються спільною поверхнею OpenClaw, але REST-інтеграція STT xAI передає лише файл, модель і мову, бо вони чітко відповідають поточному публічному endpoint xAI.
Вбудований Plugin xai також реєструє провайдера транскрипції в реальному часі для живого аудіо голосових викликів.
  • Endpoint: xAI WebSocket wss://api.x.ai/v1/stt
  • Стандартне кодування: mulaw
  • Стандартна частота дискретизації: 8000
  • Стандартне визначення кінця мовлення: 800ms
  • Проміжні транскрипти: увімкнено типово
Медіапотік Twilio у Voice Call надсилає аудіокадри 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. Підтримувані ключі: apiKey, baseUrl, sampleRate, encoding (pcm, mulaw або alaw), interimResults, endpointingMs і language.
Цей потоковий провайдер призначений для шляху транскрибування в реальному часі Voice Call. Голос Discord наразі записує короткі сегменти й натомість використовує пакетний шлях транскрибування tools.media.audio.
Вбудований Plugin xAI надає x_search як інструмент OpenClaw для пошуку вмісту X (раніше Twitter) через Grok.Шлях конфігурації: plugins.entries.xai.config.xSearch
KeyTypeDefaultDescription
enabledboolean-Увімкнути або вимкнути x_search
modelstringgrok-4-1-fastМодель, що використовується для запитів x_search
baseUrlstring-Перевизначення базової URL-адреси xAI Responses
inlineCitationsboolean-Додавати вбудовані цитати в результати
maxTurnsnumber-Максимальна кількість ходів розмови
timeoutSecondsnumber-Час очікування запиту в секундах
cacheTtlMinutesnumber-Час життя кешу в хвилинах
{
  plugins: {
    entries: {
      xai: {
        config: {
          xSearch: {
            enabled: true,
            model: "grok-4-1-fast",
            baseUrl: "https://api.x.ai/v1",
            inlineCitations: true,
          },
        },
      },
    },
  },
}
Вбудований Plugin xAI надає code_execution як інструмент OpenClaw для віддаленого виконання коду в пісочниці xAI.Шлях конфігурації: plugins.entries.xai.config.codeExecution
KeyTypeDefaultDescription
enabledbooleantrue (якщо ключ доступний)Увімкнути або вимкнути виконання коду
modelstringgrok-4-1-fastМодель, що використовується для запитів виконання коду
maxTurnsnumber-Максимальна кількість ходів розмови
timeoutSecondsnumber-Час очікування запиту в секундах
Це віддалене виконання в пісочниці xAI, а не локальний exec.
{
  plugins: {
    entries: {
      xai: {
        config: {
          codeExecution: {
            enabled: true,
            model: "grok-4-1-fast",
          },
        },
      },
    },
  },
}
  • Автентифікація сьогодні підтримує лише API-ключ. API-ключ можна зберігати в профілі автентифікації xAI, змінній середовища або конфігурації plugin; OAuth xAI або потоку device-code в OpenClaw поки немає.
  • grok-4.20-multi-agent-experimental-beta-0304 не підтримується у звичайному шляху провайдера xAI, оскільки потребує іншої поверхні upstream API, ніж стандартний транспорт OpenClaw xAI.
  • Голос xAI Realtime ще не зареєстровано як провайдера OpenClaw. Для нього потрібен інший контракт двонапрямної голосової сесії, ніж для пакетного STT або потокового транскрибування.
  • quality зображення xAI, mask зображення та додаткові співвідношення сторін лише для нативного режиму не надаються, доки спільний інструмент image_generate не матиме відповідних міжпровайдерних елементів керування.
  • OpenClaw автоматично застосовує специфічні для xAI виправлення сумісності схем інструментів і викликів інструментів у спільному шляху runner.
  • Нативні запити xAI за замовчуванням мають tool_stream: true. Установіть agents.defaults.models["xai/<model>"].params.tool_stream на false, щоб вимкнути це.
  • Вбудована обгортка xAI вилучає непідтримувані прапорці строгих схем інструментів і ключі payload reasoning перед надсиланням нативних запитів xAI.
  • web_search, x_search і code_execution надаються як інструменти OpenClaw. OpenClaw вмикає конкретний вбудований xAI-інструмент, потрібний у кожному запиті інструмента, замість того щоб додавати всі нативні інструменти до кожного ходу чату.
  • Grok web_search читає plugins.entries.xai.config.webSearch.baseUrl. x_search читає plugins.entries.xai.config.xSearch.baseUrl, а потім повертається до базової URL-адреси вебпошуку Grok.
  • x_search і code_execution належать вбудованому Plugin xAI, а не жорстко закодовані в core runtime моделей.
  • code_execution — це віддалене виконання в пісочниці xAI, а не локальний exec.

​
Live-тестування

Медійні шляхи xAI покриті модульними тестами й live-наборами, що вмикаються явно. Live-команди завантажують секрети з вашої login shell, зокрема ~/.profile, перед перевіркою XAI_API_KEY. 
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
Файл live-тестів, специфічний для провайдера, синтезує звичайний TTS, зручний для телефонії PCM TTS, транскрибує аудіо через пакетний STT xAI, потоково передає той самий PCM через realtime STT xAI, генерує результат text-to-image і редагує еталонне зображення. Спільний live-файл для зображень перевіряє того самого провайдера xAI через вибір runtime OpenClaw, fallback, нормалізацію та шлях медійних вкладень.

​
Пов’язане

Model selection

Вибір провайдерів, посилань на моделі та поведінки failover.

Video generation

Спільні параметри відеоінструмента та вибір провайдера.

All providers

Ширший огляд провайдерів.

Troubleshooting

Поширені проблеми та виправлення.