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.

Tavily adalah API pencarian yang dirancang untuk aplikasi AI. OpenClaw mengeksposnya dalam dua cara:
  • sebagai penyedia web_search untuk alat pencarian generik
  • sebagai alat Plugin eksplisit: tavily_search dan tavily_extract
Tavily mengembalikan hasil terstruktur yang dioptimalkan untuk konsumsi LLM dengan kedalaman pencarian yang dapat dikonfigurasi, pemfilteran topik, filter domain, ringkasan jawaban yang dihasilkan AI, dan ekstraksi konten dari URL (termasuk halaman yang dirender JavaScript).
PropertiNilai
Id Plugintavily
AutentikasiTAVILY_API_KEY atau config apiKey
URL dasarhttps://api.tavily.com (default)
Alat bawaantavily_search, tavily_extract

​
Memulai

1

Dapatkan kunci API

Buat akun Tavily di tavily.com, lalu buat kunci API di dasbor.
2

Konfigurasikan plugin dan penyedia

{
  plugins: {
    entries: {
      tavily: {
        enabled: true,
        config: {
          webSearch: {
            apiKey: "tvly-...", // optional if TAVILY_API_KEY is set
            baseUrl: "https://api.tavily.com",
          },
        },
      },
    },
  },
  tools: {
    web: {
      search: {
        provider: "tavily",
      },
    },
  },
}
3

Verifikasi pencarian berjalan

Picu web_search dari agent mana pun, atau panggil tavily_search secara langsung.
Memilih Tavily saat onboarding atau openclaw configure --section web mengaktifkan Plugin Tavily bawaan secara otomatis.

​
Referensi alat

Gunakan ini ketika Anda menginginkan kontrol pencarian khusus Tavily, bukan web_search generik.
ParameterJenisBatasan / defaultDeskripsi
querystringwajibString kueri pencarian. Jaga agar di bawah 400 karakter.
search_depthenumbasic (default), advancedadvanced lebih lambat tetapi relevansinya lebih tinggi.
topicenumgeneral (default), news, financeFilter berdasarkan keluarga topik.
max_resultsinteger1-20Jumlah hasil.
include_answerbooleandefault falseSertakan ringkasan jawaban yang dihasilkan AI Tavily.
time_rangeenumday, week, month, yearFilter hasil berdasarkan kebaruan.
include_domainsarray string(tidak ada)Hanya sertakan hasil dari domain-domain ini.
exclude_domainsarray string(tidak ada)Kecualikan hasil dari domain-domain ini.
Tradeoff kedalaman pencarian:
KedalamanKecepatanRelevansiPaling cocok untuk
basicLebih cepatTinggiKueri serbaguna (default).
advancedLebih lambatTertinggiRiset presisi dan pencarian fakta.

​
tavily_extract

Gunakan ini untuk mengekstrak konten bersih dari satu atau beberapa URL. Menangani halaman yang dirender JavaScript dan mendukung pemotongan berfokus kueri untuk ekstraksi yang ditargetkan.
ParameterJenisBatasan / defaultDeskripsi
urlsarray stringwajib, 1-20URL untuk mengekstrak konten.
querystring(opsional)Urutkan ulang potongan yang diekstrak berdasarkan relevansi terhadap kueri ini.
extract_depthenumbasic (default), advancedGunakan advanced untuk halaman yang berat JS, SPA, atau tabel dinamis.
chunks_per_sourceinteger1-5; membutuhkan queryPotongan yang dikembalikan per URL. Error jika disetel tanpa query.
include_imagesbooleandefault falseSertakan URL gambar dalam hasil.
Tradeoff kedalaman ekstraksi:
KedalamanKapan digunakan
basicHalaman sederhana. Coba ini terlebih dahulu.
advancedSPA yang dirender JS, konten dinamis, tabel.
Bagi daftar URL yang lebih besar menjadi beberapa panggilan tavily_extract (maks 20 per permintaan). Gunakan query plus chunks_per_source untuk mendapatkan hanya konten yang relevan, bukan halaman penuh.

​
Memilih alat yang tepat

KebutuhanAlat
Pencarian web cepat, tanpa opsi khususweb_search
Pencarian dengan kedalaman, topik, jawaban AItavily_search
Ekstrak konten dari URL tertentutavily_extract
Alat web_search generik dengan Tavily sebagai penyedia mendukung query dan count (hingga 20 hasil). Untuk kontrol khusus Tavily (search_depth, topic, include_answer, filter domain, rentang waktu), gunakan tavily_search sebagai gantinya.

​
Konfigurasi lanjutan

Klien Tavily mencari kunci API-nya dalam urutan ini:
  1. plugins.entries.tavily.config.webSearch.apiKey (diresolusikan melalui SecretRefs).
  2. TAVILY_API_KEY dari lingkungan Gateway.
tavily_extract memunculkan error penyiapan jika keduanya tidak ada.
Timpa plugins.entries.tavily.config.webSearch.baseUrl jika Anda menyalurkan Tavily melalui proksi. Default-nya adalah https://api.tavily.com.
tavily_extract menolak panggilan yang meneruskan chunks_per_source tanpa query. Tavily memeringkat potongan berdasarkan relevansi kueri, sehingga parameter tersebut tidak bermakna tanpa kueri.

​
Terkait

Ringkasan Web Search

Semua penyedia dan aturan deteksi otomatis.

Firecrawl

Pencarian plus scraping dengan ekstraksi konten.

Exa Search

Pencarian neural dengan ekstraksi konten.

Konfigurasi

Skema config lengkap untuk entri Plugin dan perutean alat.