Tavily parameters in ChatAgents are configured insideDocumentation Index
Fetch the complete documentation index at: https://mintlify.com/EllisYuan/ChatAgents/llms.txt
Use this file to discover all available pages before exploring further.
WebAgent.build_graph() in backend/agent.py. Every call to build_graph() instantiates three Tavily tools — TavilySearch, TavilyExtract, and TavilyCrawl — whose parameters are derived from the mode argument ("fast" or "deep"). Two user-configurable overrides, topic and time_range, can be passed at request time to tailor search results without switching modes.
Fast vs. Deep Mode Parameters
The table below summarises how each parameter differs between the two agent modes.| Parameter | Fast Mode | Deep Thinking Mode | Description |
|---|---|---|---|
search_depth | basic | advanced | Comprehensiveness of the Tavily search pass |
max_results | 3 | 5 | Number of search result pages returned |
include_images | False | True | Whether image URLs are included in results |
crawl_limit | 5 | 15 | Maximum number of pages crawled per TavilyCrawl call |
extract_depth | basic | advanced | Depth of content extraction for TavilyExtract |
topic | general | general | Search topic filter — user-configurable |
time_range | None | None | Temporal filter on results — user-configurable |
TavilySearch Parameters
TavilySearch is the first tool the agent reaches for. It runs a web search and returns a ranked list of results with snippets, URLs, and favicons.
- Fast Mode
- Deep Thinking Mode
Parameter Details
Controls how thoroughly Tavily crawls and indexes pages before returning results.
"basic"— Fast, lower cost. Suitable for simple factual queries."advanced"— Comprehensive multi-pass crawl. More accurate for complex or ambiguous queries but costs more credits.
The number of search result pages Tavily returns per query. More results give the agent more evidence to reason over but increase token consumption and cost.
Instructs Tavily to prioritise sources from a particular domain:
"general"— Broad web search, no source type preference."news"— Prioritises news publishers and wire services. Best for current events."finance"— Prioritises financial data sources, market feeds, and business news.
Filters results to a specific recency window. Omitted entirely when
None (no time restriction)."day"— Last 24 hours"week"— Last 7 days"month"— Last 30 days"year"— Last 12 months
When
True, Tavily includes image URLs alongside each result. Enabled in Deep mode to support richer, visually-backed responses. Disabled in Fast mode to keep payloads small.Always
False. Tavily can return a pre-generated answer snippet, but ChatAgents disables this so the LLM agent performs its own reasoning over the raw results rather than relying on Tavily’s summarisation.Always
True. Favicons are extracted from each result and surfaced in the Streamlit frontend alongside source citations.TavilyExtract Parameters
TavilyExtract fetches and parses the full content of specific URLs. The agent calls it when a search result looks promising and deeper content is needed. Its output is passed through the summary_llm (Haiku) before being returned to the main agent, to keep token consumption manageable.
- Fast Mode
- Deep Thinking Mode
Mirrors
search_depth in philosophy:"basic"— Extracts the main text content of the page. Fast and inexpensive."advanced"— Performs a deeper extraction, capturing more structured data, tables, and secondary content blocks.
Always
True. Favicons are passed through the summarizer and surfaced as source attribution icons in the UI.Kept in sync with the corresponding
TavilySearch setting. False in Fast mode, True in Deep mode.TavilyCrawl Parameters
TavilyCrawl performs a full site crawl starting from a URL, following internal links up to limit pages. It gives the agent access to deeply nested content — documentation sites, wikis, long-form articles — that a single extract call might miss.
- Fast Mode
- Deep Thinking Mode
Maximum number of pages to crawl from the starting URL.
5(Fast) — Sufficient for simple pages; fast and low cost.15(Deep) — Covers large documentation sites, multi-page reports, or deep wikis.
Always
True for consistent source attribution in the UI.Advanced Usage Examples
Thetopic and time_range arguments to build_graph() let you tune Tavily’s focus without changing the mode. Pass them from the request layer or set them programmatically when you know the query type in advance.
Cost Analysis
Tavily charges credits per API call. The totals below are estimates based on typical agent usage patterns across all three tools in a single query turn.| Mode | Estimated Credits | Search | Extract | Crawl |
|---|---|---|---|---|
| Fast | ~15–25 credits | 3 results × basic = ~6–9 | basic, per call = ~3–5 | 5 pages = ~5–10 |
| Deep | ~50–80 credits | 5 results × advanced = ~20–30 | advanced, per call = ~10–15 | 15 pages = ~15–30 |
Credit consumption varies with query complexity. An agent that only calls
TavilySearch (no extract or crawl) will sit at the lower end of each range. Deep mode with all three tools on a complex research query will approach the upper bound.