docs/tools/tavily.md
Tavily is a search API designed for AI applications. OpenClaw exposes it in two ways:
web_search provider for the generic search tooltavily_search and tavily_extractTavily returns structured results optimized for LLM consumption with configurable search depth, topic filtering, domain filters, AI-generated answer summaries, and content extraction from URLs (including JavaScript-rendered pages).
| Property | Value |
|---|---|
| Plugin id | tavily |
| Auth | TAVILY_API_KEY or config apiKey |
| Base URL | https://api.tavily.com (default) |
| Bundled tools | tavily_search, tavily_extract |
tavily_searchUse this when you want Tavily-specific search controls instead of generic web_search.
| Parameter | Type | Constraints / default | Description |
|---|---|---|---|
query | string | required | Search query string. Keep under 400 characters. |
search_depth | enum | basic (default), advanced | advanced is slower but higher relevance. |
topic | enum | general (default), news, finance | Filter by topic family. |
max_results | integer | 1-20 | Number of results. |
include_answer | boolean | default false | Include a Tavily AI-generated answer summary. |
time_range | enum | day, week, month, year | Filter results by recency. |
include_domains | string array | (none) | Only include results from these domains. |
exclude_domains | string array | (none) | Exclude results from these domains. |
Search depth tradeoff:
| Depth | Speed | Relevance | Best for |
|---|---|---|---|
basic | Faster | High | General-purpose queries (default). |
advanced | Slower | Highest | Precision research and fact-finding. |
tavily_extractUse this to extract clean content from one or more URLs. Handles JavaScript-rendered pages and supports query-focused chunking for targeted extraction.
| Parameter | Type | Constraints / default | Description |
|---|---|---|---|
urls | string array | required, 1-20 | URLs to extract content from. |
query | string | (optional) | Rerank extracted chunks by relevance to this query. |
extract_depth | enum | basic (default), advanced | Use advanced for JS-heavy pages, SPAs, or dynamic tables. |
chunks_per_source | integer | 1-5; requires query | Chunks returned per URL. Errors if set without query. |
include_images | boolean | default false | Include image URLs in results. |
Extract depth tradeoff:
| Depth | When to use |
|---|---|
basic | Simple pages. Try this first. |
advanced | JS-rendered SPAs, dynamic content, tables. |
| Need | Tool |
|---|---|
| Quick web search, no special options | web_search |
| Search with depth, topic, AI answers | tavily_search |
| Extract content from specific URLs | tavily_extract |
1. `plugins.entries.tavily.config.webSearch.apiKey` (resolved through SecretRefs).
2. `TAVILY_API_KEY` from the gateway environment.
`tavily_extract` raises a setup error if neither is present.