Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs2.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

Tavily 是一个面向 AI 应用设计的搜索 API。OpenClaw 以两种方式公开它：
  • 作为通用搜索工具的 web_search 提供商
  • 作为显式插件工具：tavily_search 和 tavily_extract
Tavily 返回针对 LLM 消费优化的结构化结果，支持可配置的搜索深度、主题过滤、域名过滤、AI 生成的答案摘要，以及从 URL 提取内容（包括 JavaScript 渲染的页面）。
属性值
插件 idtavily
凭证TAVILY_API_KEY 或配置 apiKey
基础 URLhttps://api.tavily.com（默认）
内置工具tavily_search, tavily_extract

​
入门指南

1

获取 API key

在 tavily.com 创建 Tavily 账户，然后在控制台中生成 API key。
2

配置插件和提供商

{
  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

验证搜索能运行

从任意智能体触发一次 web_search，或直接调用 tavily_search。
在新手引导或 openclaw configure --section web 中选择 Tavily 会自动启用内置的 Tavily 插件。

​
工具参考

当你需要使用 Tavily 特有的搜索控制，而不是通用的 web_search 时，请使用此工具。
参数类型约束 / 默认值描述
querystring必填搜索查询字符串。保持在 400 个字符以内。
search_depthenumbasic（默认）、advancedadvanced 较慢，但相关性更高。
topicenumgeneral（默认）、news、finance按主题类别过滤。
max_resultsinteger1-20结果数量。
include_answerboolean默认 false包含 Tavily AI 生成的答案摘要。
time_rangeenumday、week、month、year按新近程度过滤结果。
include_domainsstring array（无）仅包含来自这些域名的结果。
exclude_domainsstring array（无）排除来自这些域名的结果。
搜索深度权衡：
深度速度相关性最适合
basic更快高通用查询（默认）。
advanced更慢最高精确研究和事实查找。

​
tavily_extract

使用此工具从一个或多个 URL 提取干净内容。可处理 JavaScript 渲染的页面，并支持面向查询的分块，用于有针对性的提取。
参数类型约束 / 默认值描述
urlsstring array必填，1-20要从中提取内容的 URL。
querystring（可选）按与此查询的相关性对提取的分块重新排序。
extract_depthenumbasic（默认）、advanced对 JS 较重的页面、SPA 或动态表格使用 advanced。
chunks_per_sourceinteger1-5；需要 query每个 URL 返回的分块数。如果未设置 query 则会报错。
include_imagesboolean默认 false在结果中包含图片 URL。
提取深度权衡：
深度何时使用
basic简单页面。先尝试这个。
advancedJS 渲染的 SPA、动态内容、表格。
将较大的 URL 列表拆分为多次 tavily_extract 调用（每次请求最多 20 个）。使用 query 加 chunks_per_source，只获取相关内容，而不是完整页面。

​
选择合适的工具

需求工具
快速 Web 搜索，无特殊选项web_search
使用深度、主题、AI 答案进行搜索tavily_search
从特定 URL 提取内容tavily_extract
以 Tavily 作为提供商的通用 web_search 工具支持 query 和 count（最多 20 个结果）。对于 Tavily 特有的控制项（search_depth、topic、include_answer、域名过滤、时间范围），请改用 tavily_search。

​
高级配置

Tavily 客户端按以下顺序查找其 API key：
  1. plugins.entries.tavily.config.webSearch.apiKey（通过 SecretRefs 解析）。
  2. Gateway 网关环境中的 TAVILY_API_KEY。
如果两者都不存在，tavily_extract 会抛出设置错误。
如果你通过代理前置 Tavily，请覆盖 plugins.entries.tavily.config.webSearch.baseUrl。默认值为 https://api.tavily.com。
tavily_extract 会拒绝传入 chunks_per_source 但未传入 query 的调用。Tavily 会按查询相关性对分块排序，因此没有查询时该参数没有意义。

​
相关

Web 搜索概览

所有提供商和自动检测规则。

Firecrawl

搜索加内容提取式抓取。

Exa Search

带内容提取的神经搜索。

配置

插件条目和工具路由的完整配置架构。