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.

Alat web_search menelusuri web menggunakan penyedia yang Anda konfigurasi dan mengembalikan hasil. Hasil di-cache berdasarkan kueri selama 15 menit (dapat dikonfigurasi). OpenClaw juga menyertakan x_search untuk postingan X (sebelumnya Twitter) dan web_fetch untuk pengambilan URL ringan. Pada fase ini, web_fetch tetap lokal sementara web_search dan x_search dapat menggunakan xAI Responses di balik layar.
web_search adalah alat HTTP ringan, bukan otomasi browser. Untuk situs yang berat JS atau login, gunakan Browser Web. Untuk mengambil URL tertentu, gunakan Web Fetch.

Mulai cepat

1

Choose a provider

Pilih penyedia dan selesaikan penyiapan yang diperlukan. Beberapa penyedia bebas kunci, sementara yang lain menggunakan kunci API. Lihat halaman penyedia di bawah untuk detail.
2

Configure

openclaw configure --section web
Ini menyimpan penyedia dan kredensial yang diperlukan. Anda juga dapat menetapkan env var (misalnya BRAVE_API_KEY) dan melewati langkah ini untuk penyedia berbasis API.
3

Use it

Agen sekarang dapat memanggil web_search:
await web_search({ query: "OpenClaw plugin SDK" });
Untuk postingan X, gunakan:
await x_search({ query: "dinner recipes" });

Memilih penyedia

Brave Search

Hasil terstruktur dengan cuplikan. Mendukung mode llm-context, filter negara/bahasa. Tingkat gratis tersedia.

DuckDuckGo

Fallback bebas kunci. Tidak perlu kunci API. Integrasi tidak resmi berbasis HTML.

Exa

Pencarian neural + kata kunci dengan ekstraksi konten (sorotan, teks, ringkasan).

Firecrawl

Hasil terstruktur. Paling baik dipasangkan dengan firecrawl_search dan firecrawl_scrape untuk ekstraksi mendalam.

Gemini

Jawaban yang disintesis AI dengan sitasi melalui grounding Google Search.

Grok

Jawaban yang disintesis AI dengan sitasi melalui grounding web xAI.

Kimi

Jawaban yang disintesis AI dengan sitasi melalui pencarian web Moonshot; fallback chat tanpa grounding gagal secara eksplisit.

MiniMax Search

Hasil terstruktur melalui API pencarian MiniMax Token Plan.

Ollama Web Search

Pencarian melalui host Ollama lokal yang sudah masuk atau API Ollama yang di-host.

Perplexity

Hasil terstruktur dengan kontrol ekstraksi konten dan pemfilteran domain.

SearXNG

Meta-pencarian yang di-host sendiri. Tidak perlu kunci API. Mengagregasi Google, Bing, DuckDuckGo, dan lainnya.

Tavily

Hasil terstruktur dengan kedalaman pencarian, pemfilteran topik, dan tavily_extract untuk ekstraksi URL.

Perbandingan penyedia

PenyediaGaya hasilFilterKunci API
BraveCuplikan terstrukturNegara, bahasa, waktu, mode llm-contextBRAVE_API_KEY
DuckDuckGoCuplikan terstrukturTidak ada (bebas kunci)
ExaTerstruktur + diekstrakMode neural/kata kunci, tanggal, ekstraksi kontenEXA_API_KEY
FirecrawlCuplikan terstrukturMelalui alat firecrawl_searchFIRECRAWL_API_KEY
GeminiDisintesis AI + sitasiGEMINI_API_KEY
GrokDisintesis AI + sitasiXAI_API_KEY
KimiDisintesis AI + sitasi; gagal pada fallback chat tanpa groundingKIMI_API_KEY / MOONSHOT_API_KEY
MiniMax SearchCuplikan terstrukturWilayah (global / cn)MINIMAX_CODE_PLAN_KEY / MINIMAX_CODING_API_KEY / MINIMAX_OAUTH_TOKEN
Ollama Web SearchCuplikan terstrukturTidak ada untuk host lokal yang sudah masuk; OLLAMA_API_KEY untuk pencarian langsung https://ollama.com
PerplexityCuplikan terstrukturNegara, bahasa, waktu, domain, batas kontenPERPLEXITY_API_KEY / OPENROUTER_API_KEY
SearXNGCuplikan terstrukturKategori, bahasaTidak ada (di-host sendiri)
TavilyCuplikan terstrukturMelalui alat tavily_searchTAVILY_API_KEY

Deteksi otomatis

Pencarian web OpenAI native

Model OpenAI Responses langsung menggunakan alat web_search yang di-host OpenAI secara otomatis ketika pencarian web OpenClaw diaktifkan dan tidak ada penyedia terkelola yang dipatok. Ini adalah perilaku milik penyedia di Plugin OpenAI bawaan dan hanya berlaku untuk lalu lintas API OpenAI native, bukan URL dasar proxy yang kompatibel dengan OpenAI atau rute Azure. Tetapkan tools.web.search.provider ke penyedia lain seperti brave untuk tetap menggunakan alat web_search terkelola bagi model OpenAI, atau tetapkan tools.web.search.enabled: false untuk menonaktifkan pencarian terkelola dan pencarian OpenAI native.

Pencarian web Codex native

Model berkemampuan Codex secara opsional dapat menggunakan alat web_search Responses native penyedia, bukan fungsi web_search terkelola OpenClaw.
  • Konfigurasikan di bawah tools.web.search.openaiCodex
  • Ini hanya aktif untuk model berkemampuan Codex (openai-codex/* atau penyedia yang menggunakan api: "openai-codex-responses")
  • web_search terkelola tetap berlaku untuk model non-Codex
  • mode: "cached" adalah pengaturan default dan direkomendasikan
  • tools.web.search.enabled: false menonaktifkan pencarian terkelola dan native
{
  tools: {
    web: {
      search: {
        enabled: true,
        openaiCodex: {
          enabled: true,
          mode: "cached",
          allowedDomains: ["example.com"],
          contextSize: "high",
          userLocation: {
            country: "US",
            city: "New York",
            timezone: "America/New_York",
          },
        },
      },
    },
  },
}
Jika pencarian Codex native diaktifkan tetapi model saat ini tidak berkemampuan Codex, OpenClaw mempertahankan perilaku web_search terkelola normal.

Keamanan jaringan

Panggilan penyedia web_search terkelola menggunakan jalur fetch terlindungi milik OpenClaw. Untuk host API penyedia tepercaya, OpenClaw mengizinkan jawaban DNS fake-IP Surge, Clash, dan sing-box di 198.18.0.0/15 dan fc00::/7 hanya untuk nama host penyedia tersebut. Tujuan privat, loopback, link-local, dan metadata lainnya tetap diblokir. Pengecualian otomatis ini tidak berlaku untuk URL web_fetch sembarang. Untuk web_fetch, aktifkan tools.web.fetch.ssrfPolicy.allowRfc2544BenchmarkRange dan tools.web.fetch.ssrfPolicy.allowIpv6UniqueLocalRange secara eksplisit hanya ketika proxy tepercaya Anda memiliki rentang sintetis tersebut.

Menyiapkan pencarian web

Daftar penyedia dalam docs dan alur penyiapan disusun alfabetis. Deteksi otomatis mempertahankan urutan prioritas terpisah. Jika tidak ada provider yang ditetapkan, OpenClaw memeriksa penyedia dalam urutan ini dan menggunakan yang pertama siap: Penyedia berbasis API lebih dahulu:
  1. BraveBRAVE_API_KEY atau plugins.entries.brave.config.webSearch.apiKey (urutan 10)
  2. MiniMax SearchMINIMAX_CODE_PLAN_KEY / MINIMAX_CODING_API_KEY / MINIMAX_OAUTH_TOKEN / MINIMAX_API_KEY atau plugins.entries.minimax.config.webSearch.apiKey (urutan 15)
  3. Geminiplugins.entries.google.config.webSearch.apiKey, GEMINI_API_KEY, atau models.providers.google.apiKey (urutan 20)
  4. GrokXAI_API_KEY atau plugins.entries.xai.config.webSearch.apiKey (urutan 30)
  5. KimiKIMI_API_KEY / MOONSHOT_API_KEY atau plugins.entries.moonshot.config.webSearch.apiKey (urutan 40)
  6. PerplexityPERPLEXITY_API_KEY / OPENROUTER_API_KEY atau plugins.entries.perplexity.config.webSearch.apiKey (urutan 50)
  7. FirecrawlFIRECRAWL_API_KEY atau plugins.entries.firecrawl.config.webSearch.apiKey (urutan 60)
  8. ExaEXA_API_KEY atau plugins.entries.exa.config.webSearch.apiKey; plugins.entries.exa.config.webSearch.baseUrl opsional mengganti endpoint Exa (urutan 65)
  9. TavilyTAVILY_API_KEY atau plugins.entries.tavily.config.webSearch.apiKey (urutan 70)
Fallback bebas kunci setelah itu:
  1. DuckDuckGo — fallback HTML bebas kunci tanpa akun atau kunci API (urutan 100)
  2. Ollama Web Search — fallback bebas kunci melalui host Ollama lokal yang Anda konfigurasi ketika dapat dijangkau dan sudah masuk dengan ollama signin; dapat menggunakan ulang autentikasi bearer penyedia Ollama ketika host memerlukannya, dan dapat memanggil pencarian langsung https://ollama.com ketika dikonfigurasi dengan OLLAMA_API_KEY (urutan 110)
  3. SearXNGSEARXNG_BASE_URL atau plugins.entries.searxng.config.webSearch.baseUrl (urutan 200)
Jika tidak ada penyedia yang terdeteksi, sistem melakukan fallback ke Brave (Anda akan mendapatkan error kunci hilang yang meminta Anda mengonfigurasinya).
Semua bidang kunci penyedia mendukung objek SecretRef. SecretRef yang dicakup Plugin di bawah plugins.entries.<plugin>.config.webSearch.apiKey diselesaikan untuk penyedia pencarian web berbasis API bawaan, termasuk Brave, Exa, Firecrawl, Gemini, Grok, Kimi, MiniMax, Perplexity, dan Tavily, baik penyedia dipilih secara eksplisit melalui tools.web.search.provider maupun dipilih melalui deteksi otomatis. Dalam mode deteksi otomatis, OpenClaw hanya menyelesaikan kunci penyedia yang dipilih — SecretRef yang tidak dipilih tetap tidak aktif, sehingga Anda dapat mempertahankan beberapa penyedia yang dikonfigurasi tanpa membayar biaya penyelesaian untuk yang tidak Anda gunakan.

Konfigurasi

{
  tools: {
    web: {
      search: {
        enabled: true, // default: true
        provider: "brave", // or omit for auto-detection
        maxResults: 5,
        timeoutSeconds: 30,
        cacheTtlMinutes: 15,
      },
    },
  },
}
Konfigurasi khusus penyedia (kunci API, URL dasar, mode) berada di bawah plugins.entries.<plugin>.config.webSearch.*. Gemini juga dapat menggunakan kembali models.providers.google.apiKey dan models.providers.google.baseUrl sebagai fallback berprioritas lebih rendah setelah konfigurasi pencarian web khususnya dan GEMINI_API_KEY. Lihat halaman penyedia untuk contoh. tools.web.search.provider divalidasi terhadap id penyedia pencarian web yang dideklarasikan oleh manifes Plugin bawaan dan terinstal. Kesalahan ketik seperti "brvae" menggagalkan validasi konfigurasi alih-alih diam-diam kembali ke deteksi otomatis. Jika penyedia yang dikonfigurasi hanya memiliki bukti Plugin yang usang, seperti blok plugins.entries.<plugin> tersisa setelah menghapus Plugin pihak ketiga, OpenClaw menjaga startup tetap tangguh dan melaporkan peringatan agar Anda dapat menginstal ulang Plugin atau menjalankan openclaw doctor --fix untuk membersihkan konfigurasi usang. Pemilihan penyedia fallback web_fetch terpisah:
  • pilih dengan tools.web.fetch.provider
  • atau hilangkan kolom itu dan biarkan OpenClaw mendeteksi otomatis penyedia web-fetch siap pertama dari kredensial yang tersedia
  • web_fetch non-sandbox dapat menggunakan penyedia Plugin terinstal yang mendeklarasikan contracts.webFetchProviders; fetch tersandbox tetap hanya bawaan
  • saat ini penyedia web-fetch bawaan adalah Firecrawl, dikonfigurasi di bawah plugins.entries.firecrawl.config.webFetch.*
Saat Anda memilih Kimi selama openclaw onboard atau openclaw configure --section web, OpenClaw juga dapat meminta:
  • wilayah API Moonshot (https://api.moonshot.ai/v1 atau https://api.moonshot.cn/v1)
  • model pencarian web Kimi default (default ke kimi-k2.6)
Untuk x_search, konfigurasikan plugins.entries.xai.config.xSearch.*. Ini menggunakan profil autentikasi xAI yang sama seperti chat, atau XAI_API_KEY / kredensial pencarian web Plugin yang digunakan oleh pencarian web Grok. Konfigurasi lama tools.web.x_search.* dimigrasikan otomatis oleh openclaw doctor --fix. Saat Anda memilih Grok selama openclaw onboard atau openclaw configure --section web, OpenClaw juga dapat menawarkan penyiapan x_search opsional dengan kunci yang sama. Ini adalah langkah lanjutan terpisah di dalam jalur Grok, bukan pilihan penyedia pencarian web tingkat atas yang terpisah. Jika Anda memilih penyedia lain, OpenClaw tidak menampilkan prompt x_search.

Menyimpan kunci API

Jalankan openclaw configure --section web atau atur kunci secara langsung:
{
  plugins: {
    entries: {
      brave: {
        config: {
          webSearch: {
            apiKey: "YOUR_KEY", // pragma: allowlist secret
          },
        },
      },
    },
  },
}

Parameter alat

ParameterDeskripsi
queryKueri pencarian (wajib)
countHasil yang dikembalikan (1-10, default: 5)
countryKode negara ISO 2 huruf (mis. “US”, “DE”)
languageKode bahasa ISO 639-1 (mis. “en”, “de”)
search_langKode bahasa pencarian (hanya Brave)
freshnessFilter waktu: day, week, month, atau year
date_afterHasil setelah tanggal ini (YYYY-MM-DD)
date_beforeHasil sebelum tanggal ini (YYYY-MM-DD)
ui_langKode bahasa UI (hanya Brave)
domain_filterArray daftar izinkan/tolak domain (hanya Perplexity)
max_tokensTotal anggaran konten, default 25000 (hanya Perplexity)
max_tokens_per_pageBatas token per halaman, default 2048 (hanya Perplexity)
Tidak semua parameter berfungsi dengan semua penyedia. Mode Brave llm-context menolak ui_lang; date_before juga membutuhkan date_after karena rentang freshness khusus Brave memerlukan tanggal mulai dan akhir. Gemini, Grok, dan Kimi mengembalikan satu jawaban tersintesis dengan sitasi. Mereka menerima count untuk kompatibilitas alat bersama, tetapi itu tidak mengubah bentuk jawaban yang di-grounding. Gemini mendukung freshness, date_after, dan date_before dengan mengonversinya menjadi rentang waktu grounding Google Search. Perplexity berperilaku sama ketika Anda menggunakan jalur kompatibilitas Sonar/OpenRouter (plugins.entries.perplexity.config.webSearch.baseUrl / model atau OPENROUTER_API_KEY). SearXNG menerima http:// hanya untuk host jaringan privat atau loopback tepercaya; endpoint SearXNG publik harus menggunakan https://. Firecrawl dan Tavily hanya mendukung query dan count melalui web_search — gunakan alat khusus mereka untuk opsi lanjutan.
x_search mengueri postingan X (sebelumnya Twitter) menggunakan xAI dan mengembalikan jawaban yang disintesis AI dengan sitasi. Ini menerima kueri bahasa alami dan filter terstruktur opsional. OpenClaw hanya mengaktifkan alat x_search xAI bawaan pada permintaan yang melayani panggilan alat ini.
xAI mendokumentasikan x_search sebagai pendukung pencarian kata kunci, pencarian semantik, pencarian pengguna, dan pengambilan thread. Untuk statistik engagement per postingan seperti repost, balasan, bookmark, atau tayangan, lebih baik gunakan lookup tertarget untuk URL postingan atau ID status yang tepat. Pencarian kata kunci luas dapat menemukan postingan yang benar tetapi mengembalikan metadata per postingan yang kurang lengkap. Pola yang baik adalah: temukan postingan terlebih dahulu, lalu jalankan kueri x_search kedua yang berfokus pada postingan tepat itu.
{
  plugins: {
    entries: {
      xai: {
        config: {
          xSearch: {
            enabled: true,
            model: "grok-4-1-fast-non-reasoning",
            baseUrl: "https://api.x.ai/v1", // optional, overrides webSearch.baseUrl
            inlineCitations: false,
            maxTurns: 2,
            timeoutSeconds: 30,
            cacheTtlMinutes: 15,
          },
          webSearch: {
            apiKey: "xai-...", // optional if an xAI auth profile or XAI_API_KEY is set
            baseUrl: "https://api.x.ai/v1", // optional shared xAI Responses base URL
          },
        },
      },
    },
  },
}
x_search memposting ke <baseUrl>/responses ketika plugins.entries.xai.config.xSearch.baseUrl diatur. Jika kolom itu dihilangkan, ia fallback ke plugins.entries.xai.config.webSearch.baseUrl, lalu tools.web.search.grok.baseUrl lama, dan terakhir endpoint publik xAI.
ParameterDeskripsi
queryKueri pencarian (wajib)
allowed_x_handlesBatasi hasil ke handle X tertentu
excluded_x_handlesKecualikan handle X tertentu
from_dateHanya sertakan postingan pada atau setelah tanggal ini (YYYY-MM-DD)
to_dateHanya sertakan postingan pada atau sebelum tanggal ini (YYYY-MM-DD)
enable_image_understandingIzinkan xAI memeriksa gambar yang dilampirkan ke postingan yang cocok
enable_video_understandingIzinkan xAI memeriksa video yang dilampirkan ke postingan yang cocok
await x_search({
  query: "dinner recipes",
  allowed_x_handles: ["nytfood"],
  from_date: "2026-03-01",
});
// Per-post stats: use the exact status URL or status ID when possible
await x_search({
  query: "https://x.com/huntharo/status/1905678901234567890",
});

Contoh

// Basic search
await web_search({ query: "OpenClaw plugin SDK" });

// German-specific search
await web_search({ query: "TV online schauen", country: "DE", language: "de" });

// Recent results (past week)
await web_search({ query: "AI developments", freshness: "week" });

// Date range
await web_search({
  query: "climate research",
  date_after: "2024-01-01",
  date_before: "2024-06-30",
});

// Domain filtering (Perplexity only)
await web_search({
  query: "product reviews",
  domain_filter: ["-reddit.com", "-pinterest.com"],
});

Profil alat

Jika Anda menggunakan profil alat atau allowlist, tambahkan web_search, x_search, atau group:web:
{
  tools: {
    allow: ["web_search", "x_search"],
    // or: allow: ["group:web"]  (includes web_search, x_search, and web_fetch)
  },
}

Terkait

  • Web Fetch — fetch URL dan ekstrak konten yang dapat dibaca
  • Web Browser — otomasi browser penuh untuk situs berat JS
  • Grok Search — Grok sebagai penyedia web_search
  • Ollama Web Search — pencarian web tanpa kunci melalui host Ollama Anda