Langsung ke konten utama

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 mengirimkan Plugin penyedia xai bawaan untuk model Grok.

Memulai

1

Create an API key

Buat kunci API di konsol xAI.
2

Set your API key

Tetapkan XAI_API_KEY, atau jalankan:
openclaw onboard --auth-choice xai-api-key
3

Pick a model

{
  agents: { defaults: { model: { primary: "xai/grok-4.3" } } },
}
OpenClaw menggunakan API Responses xAI sebagai transport xAI bawaan. Kunci API yang sama dari openclaw onboard --auth-choice xai-api-key juga dapat mendukung x_search kelas utama dan code_execution jarak jauh; XAI_API_KEY atau konfigurasi pencarian web Plugin juga dapat mendukung web_search yang didukung Grok. Jika Anda menyimpan kunci xAI di bawah plugins.entries.xai.config.webSearch.apiKey, penyedia model xAI bawaan juga menggunakan kembali kunci tersebut sebagai fallback. Tetapkan plugins.entries.xai.config.webSearch.baseUrl untuk merutekan web_search Grok dan, secara default, x_search melalui proxy xAI Responses operator. Penyesuaian code_execution berada di bawah plugins.entries.xai.config.codeExecution.

Katalog bawaan

OpenClaw menyertakan keluarga model xAI berikut secara langsung:
KeluargaID model
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 ini juga meneruskan resolusi ID grok-4* dan grok-code-fast* yang lebih baru saat ID tersebut mengikuti bentuk API yang sama.
grok-4.3, grok-4-fast, grok-4-1-fast, dan varian grok-4.20-beta-* adalah ref Grok berkemampuan gambar saat ini dalam katalog bawaan.

Cakupan fitur OpenClaw

Plugin bawaan memetakan permukaan API publik xAI saat ini ke kontrak penyedia dan alat bersama OpenClaw. Kapabilitas yang tidak sesuai dengan kontrak bersama (misalnya TTS streaming dan suara realtime) tidak diekspos - lihat tabel di bawah.
Kapabilitas xAIPermukaan OpenClawStatus
Chat / ResponsesPenyedia model xai/<model>Ya
Pencarian web sisi serverPenyedia web_search grokYa
Pencarian X sisi serverAlat x_searchYa
Eksekusi kode sisi serverAlat code_executionYa
Gambarimage_generateYa
Videovideo_generateYa
Text-to-speech batchmessages.tts.provider: "xai" / ttsYa
TTS streaming-Tidak diekspos; kontrak TTS OpenClaw mengembalikan buffer audio lengkap
Speech-to-text batchtools.media.audio / pemahaman mediaYa
Speech-to-text streamingVoice Call streaming.provider: "xai"Ya
Suara realtime-Belum diekspos; kontrak sesi/WebSocket berbeda
File / batchHanya kompatibilitas API model generikBukan alat OpenClaw kelas utama
OpenClaw menggunakan API REST gambar/video/TTS/STT xAI untuk pembuatan media, ucapan, dan transkripsi batch, WebSocket STT streaming xAI untuk transkripsi panggilan suara langsung, dan API Responses untuk alat model, pencarian, dan eksekusi kode. Fitur yang membutuhkan kontrak OpenClaw berbeda, seperti sesi suara realtime, didokumentasikan di sini sebagai kapabilitas upstream, bukan perilaku Plugin tersembunyi.

Pemetaan mode cepat

/fast on atau agents.defaults.models["xai/<model>"].params.fastMode: true menulis ulang permintaan xAI native sebagai berikut:
Model sumberTarget mode cepat
grok-3grok-3-fast
grok-3-minigrok-3-mini-fast
grok-4grok-4-fast
grok-4-0709grok-4-fast

Alias kompatibilitas lama

Alias lama masih dinormalisasi ke ID bawaan kanonis:
Alias lamaID kanonis
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

Fitur

Plugin xai bawaan mendaftarkan pembuatan video melalui alat bersama video_generate.
  • Model video default: xai/grok-imagine-video
  • Mode: text-to-video, image-to-video, pembuatan gambar referensi, edit video jarak jauh, dan ekstensi video jarak jauh
  • Rasio aspek: 1:1, 16:9, 9:16, 4:3, 3:4, 3:2, 2:3
  • Resolusi: 480P, 720P
  • Durasi: 1-15 detik untuk pembuatan/image-to-video, 1-10 detik saat menggunakan peran reference_image, 2-10 detik untuk ekstensi
  • Pembuatan gambar referensi: tetapkan imageRoles ke reference_image untuk setiap gambar yang disediakan; xAI menerima hingga 7 gambar seperti itu
Buffer video lokal tidak diterima. Gunakan URL http(s) jarak jauh untuk input edit/perpanjang video. Image-to-video menerima buffer gambar lokal karena OpenClaw dapat mengodekannya sebagai URL data untuk xAI.
Untuk menggunakan xAI sebagai penyedia video default:
{
  agents: {
    defaults: {
      videoGenerationModel: {
        primary: "xai/grok-imagine-video",
      },
    },
  },
}
Lihat Pembuatan Video untuk parameter alat bersama, pemilihan penyedia, dan perilaku failover.
Plugin xai bawaan mendaftarkan pembuatan gambar melalui alat bersama image_generate.
  • Model gambar default: xai/grok-imagine-image
  • Model tambahan: xai/grok-imagine-image-pro
  • Mode: text-to-image dan edit gambar referensi
  • Input referensi: satu image atau hingga lima images
  • Rasio aspek: 1:1, 16:9, 9:16, 4:3, 3:4, 2:3, 3:2
  • Resolusi: 1K, 2K
  • Jumlah: hingga 4 gambar
OpenClaw meminta respons gambar b64_json dari xAI agar media yang dibuat dapat disimpan dan dikirim melalui jalur lampiran kanal normal. Gambar referensi lokal dikonversi menjadi URL data; referensi http(s) jarak jauh diteruskan apa adanya.Untuk menggunakan xAI sebagai penyedia gambar default:
{
  agents: {
    defaults: {
      imageGenerationModel: {
        primary: "xai/grok-imagine-image",
      },
    },
  },
}
xAI juga mendokumentasikan quality, mask, user, dan rasio native tambahan seperti 1:2, 2:1, 9:20, dan 20:9. OpenClaw saat ini hanya meneruskan kontrol gambar bersama lintas penyedia; kenop khusus native yang tidak didukung sengaja tidak diekspos melalui image_generate.
Plugin xai bawaan mendaftarkan text-to-speech melalui permukaan penyedia tts bersama.
  • Suara: eve, ara, rex, sal, leo, una
  • Suara default: eve
  • Format: mp3, wav, pcm, mulaw, alaw
  • Bahasa: kode BCP-47 atau auto
  • Kecepatan: override kecepatan native penyedia
  • Format catatan suara Opus native tidak didukung
Untuk menggunakan xAI sebagai penyedia TTS default:
{
  messages: {
    tts: {
      provider: "xai",
      providers: {
        xai: {
          voiceId: "eve",
        },
      },
    },
  },
}
OpenClaw menggunakan endpoint batch /v1/tts xAI. xAI juga menawarkan TTS streaming melalui WebSocket, tetapi kontrak penyedia ucapan OpenClaw saat ini mengharapkan buffer audio lengkap sebelum pengiriman balasan.
Plugin xai bawaan mendaftarkan speech-to-text batch melalui permukaan transkripsi pemahaman media OpenClaw.
  • Model default: grok-stt
  • Endpoint: xAI REST /v1/stt
  • Jalur input: unggahan file audio multipart
  • Didukung oleh OpenClaw di mana pun transkripsi audio masuk menggunakan tools.media.audio, termasuk segmen kanal suara Discord dan lampiran audio kanal
Untuk memaksa xAI bagi transkripsi audio masuk:
{
  tools: {
    media: {
      audio: {
        models: [
          {
            type: "provider",
            provider: "xai",
            model: "grok-stt",
          },
        ],
      },
    },
  },
}
Bahasa dapat disediakan melalui konfigurasi media audio bersama atau permintaan transkripsi per panggilan. Petunjuk prompt diterima oleh permukaan OpenClaw bersama, tetapi integrasi STT REST xAI hanya meneruskan file, model, dan bahasa karena ketiganya dipetakan dengan jelas ke endpoint xAI publik saat ini.
Plugin xai bawaan juga mendaftarkan penyedia transkripsi realtime untuk audio panggilan suara langsung.
  • Endpoint: xAI WebSocket wss://api.x.ai/v1/stt
  • Encoding default: mulaw
  • Laju sampel default: 8000
  • Endpointing default: 800ms
  • Transkrip sementara: diaktifkan secara default
Stream media Twilio Voice Call mengirim frame audio G.711 µ-law, sehingga penyedia xAI dapat meneruskan frame tersebut secara langsung tanpa transcoding:
{
  plugins: {
    entries: {
      "voice-call": {
        config: {
          streaming: {
            enabled: true,
            provider: "xai",
            providers: {
              xai: {
                apiKey: "${XAI_API_KEY}",
                endpointingMs: 800,
                language: "en",
              },
            },
          },
        },
      },
    },
  },
}
Konfigurasi milik penyedia berada di bawah plugins.entries.voice-call.config.streaming.providers.xai. Kunci yang didukung adalah apiKey, baseUrl, sampleRate, encoding (pcm, mulaw, atau alaw), interimResults, endpointingMs, dan language.
Penyedia streaming ini adalah untuk jalur transkripsi realtime Voice Call. Voice Discord saat ini merekam segmen pendek dan menggunakan jalur transkripsi batch tools.media.audio sebagai gantinya.
Plugin xAI bawaan mengekspos code_execution sebagai alat OpenClaw untuk eksekusi kode jarak jauh di lingkungan sandbox xAI.Jalur config: plugins.entries.xai.config.codeExecution
KunciTipeBawaanDeskripsi
enabledbooleantrue (jika kunci tersedia)Aktifkan atau nonaktifkan eksekusi kode
modelstringgrok-4-1-fastModel yang digunakan untuk permintaan eksekusi kode
maxTurnsnumber-Jumlah giliran percakapan maksimum
timeoutSecondsnumber-Timeout permintaan dalam detik
Ini adalah eksekusi sandbox xAI jarak jauh, bukan exec lokal.
{
  plugins: {
    entries: {
      xai: {
        config: {
          codeExecution: {
            enabled: true,
            model: "grok-4-1-fast",
          },
        },
      },
    },
  },
}
  • Auth saat ini hanya berbasis API key. API key dapat disimpan dalam profil auth xAI, variabel lingkungan, atau config Plugin; belum ada alur OAuth xAI atau kode perangkat di OpenClaw.
  • grok-4.20-multi-agent-experimental-beta-0304 tidak didukung pada jalur penyedia xAI normal karena memerlukan permukaan API upstream yang berbeda dari transport xAI OpenClaw standar.
  • Suara Realtime xAI belum terdaftar sebagai penyedia OpenClaw. Ini memerlukan kontrak sesi suara bidirectional yang berbeda dari STT batch atau transkripsi streaming.
  • quality gambar xAI, mask gambar, dan rasio aspek tambahan yang hanya native tidak diekspos sampai alat bersama image_generate memiliki kontrol lintas-penyedia yang sesuai.
  • OpenClaw menerapkan perbaikan kompatibilitas tool-schema dan tool-call khusus xAI secara otomatis pada jalur runner bersama.
  • Permintaan xAI native menetapkan tool_stream: true secara default. Atur agents.defaults.models["xai/<model>"].params.tool_stream ke false untuk menonaktifkannya.
  • Wrapper xAI bawaan menghapus flag tool-schema strict yang tidak didukung dan kunci payload reasoning sebelum mengirim permintaan xAI native.
  • web_search, x_search, dan code_execution diekspos sebagai alat OpenClaw. OpenClaw mengaktifkan built-in xAI spesifik yang dibutuhkan di dalam setiap permintaan alat, alih-alih melampirkan semua alat native ke setiap giliran chat.
  • Grok web_search membaca plugins.entries.xai.config.webSearch.baseUrl. x_search membaca plugins.entries.xai.config.xSearch.baseUrl, lalu fallback ke URL dasar web-search Grok.
  • x_search dan code_execution dimiliki oleh Plugin xAI bawaan, bukan di-hardcode ke runtime model inti.
  • code_execution adalah eksekusi sandbox xAI jarak jauh, bukan exec lokal.

Pengujian live

Jalur media xAI dicakup oleh pengujian unit dan suite live opt-in. Perintah live memuat secret dari shell login Anda, termasuk ~/.profile, sebelum memeriksa 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
File live khusus penyedia menyintesis TTS normal, TTS PCM yang ramah telepon, mentranskripsi audio melalui STT batch xAI, melakukan streaming PCM yang sama melalui STT realtime xAI, menghasilkan output text-to-image, dan mengedit gambar referensi. File live gambar bersama memverifikasi penyedia xAI yang sama melalui pemilihan runtime, fallback, normalisasi, dan jalur lampiran media OpenClaw.

Terkait

Pemilihan model

Memilih penyedia, referensi model, dan perilaku failover.

Pembuatan video

Parameter alat video bersama dan pemilihan penyedia.

Semua penyedia

Gambaran umum penyedia yang lebih luas.

Pemecahan masalah

Masalah umum dan perbaikannya.