Zum Hauptinhalt springen

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 ist eine Such-API, die für KI-Anwendungen entwickelt wurde. OpenClaw stellt sie auf zwei Arten bereit:
  • als web_search-Provider für das generische Such-Tool
  • als explizite Plugin-Tools: tavily_search und tavily_extract
Tavily gibt strukturierte Ergebnisse zurück, die für die Nutzung durch LLMs optimiert sind, mit konfigurierbarer Suchtiefe, Themenfilterung, Domain-Filtern, KI-generierten Antwortzusammenfassungen und Inhaltsextraktion aus URLs (einschließlich JavaScript-gerenderter Seiten).
EigenschaftWert
Plugin-IDtavily
AuthentifizierungTAVILY_API_KEY oder Konfiguration apiKey
Basis-URLhttps://api.tavily.com (Standard)
Gebündelte Toolstavily_search, tavily_extract

​
Erste Schritte

1

Get an API key

Erstellen Sie ein Tavily-Konto unter tavily.com, und generieren Sie anschließend im Dashboard einen API-Schlüssel.
2

Configure the plugin and provider

{
  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

Verify search runs

Lösen Sie eine web_search über einen beliebigen Agenten aus, oder rufen Sie tavily_search direkt auf.
Wenn Sie Tavily im Onboarding oder mit openclaw configure --section web auswählen, wird das gebündelte Tavily-Plugin automatisch aktiviert.

​
Tool-Referenz

Verwenden Sie dies, wenn Sie Tavily-spezifische Suchsteuerungen statt des generischen web_search nutzen möchten.
ParameterTypEinschränkungen / StandardBeschreibung
querystringerforderlichSuchabfragezeichenfolge. Unter 400 Zeichen halten.
search_depthenumbasic (Standard), advancedadvanced ist langsamer, aber relevanter.
topicenumgeneral (Standard), news, financeNach Themenfamilie filtern.
max_resultsinteger1-20Anzahl der Ergebnisse.
include_answerbooleanStandard falseEine KI-generierte Tavily-Antwortzusammenfassung einschließen.
time_rangeenumday, week, month, yearErgebnisse nach Aktualität filtern.
include_domainsstring array(keine)Nur Ergebnisse aus diesen Domains einschließen.
exclude_domainsstring array(keine)Ergebnisse aus diesen Domains ausschließen.
Kompromiss bei der Suchtiefe:
TiefeGeschwindigkeitRelevanzAm besten geeignet für
basicSchnellerHochAllgemeine Abfragen (Standard).
advancedLangsamerAm höchstenPräzise Recherche und Faktenfindung.

​
tavily_extract

Verwenden Sie dies, um bereinigte Inhalte aus einer oder mehreren URLs zu extrahieren. Unterstützt JavaScript-gerenderte Seiten und abfrageorientiertes Chunking für gezielte Extraktion.
ParameterTypEinschränkungen / StandardBeschreibung
urlsstring arrayerforderlich, 1-20URLs, aus denen Inhalte extrahiert werden sollen.
querystring(optional)Extrahierte Chunks nach Relevanz für diese Abfrage neu ranken.
extract_depthenumbasic (Standard), advancedVerwenden Sie advanced für JS-lastige Seiten, SPAs oder dynamische Tabellen.
chunks_per_sourceinteger1-5; erfordert queryPro URL zurückgegebene Chunks. Führt zu Fehlern, wenn ohne query gesetzt.
include_imagesbooleanStandard falseBild-URLs in Ergebnisse einschließen.
Kompromiss bei der Extraktionstiefe:
TiefeWann verwenden
basicEinfache Seiten. Versuchen Sie dies zuerst.
advancedJS-gerenderte SPAs, dynamische Inhalte, Tabellen.
Teilen Sie größere URL-Listen in mehrere tavily_extract-Aufrufe auf (max. 20 pro Anfrage). Verwenden Sie query plus chunks_per_source, um nur relevante Inhalte statt vollständiger Seiten zu erhalten.

​
Das richtige Tool auswählen

BedarfTool
Schnelle Websuche ohne Spezialoptionenweb_search
Suche mit Tiefe, Thema, KI-Antwortentavily_search
Inhalte aus bestimmten URLs extrahierentavily_extract
Das generische Tool web_search mit Tavily als Provider unterstützt query und count (bis zu 20 Ergebnisse). Für Tavily-spezifische Steuerungen (search_depth, topic, include_answer, Domain-Filter, Zeitraum) verwenden Sie stattdessen tavily_search.

​
Erweiterte Konfiguration

Der Tavily-Client sucht seinen API-Schlüssel in dieser Reihenfolge:
  1. plugins.entries.tavily.config.webSearch.apiKey (über SecretRefs aufgelöst).
  2. TAVILY_API_KEY aus der Gateway-Umgebung.
tavily_extract löst einen Einrichtungsfehler aus, wenn keines von beiden vorhanden ist.
Überschreiben Sie plugins.entries.tavily.config.webSearch.baseUrl, wenn Sie Tavily über einen Proxy vorschalten. Der Standard ist https://api.tavily.com.
tavily_extract weist Aufrufe zurück, die chunks_per_source ohne query übergeben. Tavily rankt Chunks nach Abfragerelevanz, daher ist der Parameter ohne eine Abfrage bedeutungslos.

​
Verwandte Themen

Web Search overview

Alle Provider und Regeln zur automatischen Erkennung.

Firecrawl

Suche plus Scraping mit Inhaltsextraktion.

Exa Search

Neuronale Suche mit Inhaltsextraktion.

Configuration

Vollständiges Konfigurationsschema für Plugin-Einträge und Tool-Routing.