Skip to main content
Tavily logo
  • Category: web search & research
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 5
  • Triggers: 0
  • Slug: TAVILY
  • Version: 20261101_00
  • Instant: Supported on the latest version. Support varies by tool.

Tools

Slug: TAVILY_CRAWLTool to perform intelligent graph-based website crawling with parallel path exploration and content extraction. Use when you need to traverse and extract content from multiple pages of a website following specific patterns or instructions. Supports depth/breadth controls, domain filtering, and natural language instructions for guided crawling.

Input Parameters

string
required
Root URL to begin the crawl. Can be provided with or without protocol (e.g., ‘docs.tavily.com’ or ‘https://docs.tavily.com’).
integer
Total number of links to process before stopping the crawl.
string ("markdown" | "text")
Format of the extracted content: ‘markdown’ or ‘text’.
integer
Maximum wait time in seconds for the crawl operation. Range: 10-150.
integer
Maximum crawl depth from base URL. Range: 1-5. Depth of 1 means only direct links from the root URL.
integer
Maximum number of links to follow per page level.
string
Natural language guidance for the crawler to find specific pages or content. Using instructions raises the cost to 2 credits per 10 pages. Example: ‘Find all pages about the Python SDK’.
array
List of regex patterns for specific URL paths to include. Example: [‘/docs/.’, ‘/api/.’].
array
List of regex patterns to skip certain URL paths. Example: [‘/admin/.’, ‘/private/.’].
string ("basic" | "advanced")
Extraction level for content: ‘basic’ for standard extraction or ‘advanced’ for deeper analysis.
boolean
If true, includes credit usage information in the response.
boolean
If true, includes links to external domains in the crawl.
boolean
If true, includes images in the crawl results.
array
List of regex patterns for domain filtering. Only URLs matching these patterns will be crawled.
array
List of regex patterns to exclude certain domains from the crawl.
boolean
If true, includes favicon URLs in the results.
integer
Maximum content snippets per source (max 500 chars each). Range: 1-5.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVILY_EXTRACTExtract web page content from specified URLs using Tavily, with optional image extraction and query-based content reranking. Managed Tavily requests support basic extraction depth only.Instant: Supported on the latest version.Instant pricing: $0.008 per 5 successful URL extractions.Discount: 50

Input Parameters

string
required
URL(s) to extract content from. Can be a single URL string or a list of URL strings.
string
User intent for reranking extracted content chunks. Helps prioritize the most relevant extracted content based on the query.
string ("markdown" | "text")
Content format for extraction: ‘markdown’ or ‘text’. Default is ‘markdown’.
number
Maximum wait time in seconds for the extraction request. Must be between 1.0 and 60.0 seconds. Default is 30.0.
string ("basic" | "advanced")
Extraction depth level: ‘basic’ for standard extraction or ‘advanced’ for more in-depth extraction. Default is ‘basic’.
boolean
If true, includes credit usage information in the response.
boolean
If true, includes a list of image URLs found in the extracted content.
boolean
If true, includes the favicon URL for each result.
integer
Maximum number of relevant chunks to extract per source. Must be between 1 and 5. Default is 3.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVILY_GET_USAGETool to retrieve API key and account usage statistics from Tavily. Use when you need to check credit consumption, limits, and per-endpoint usage for search, extract, crawl, map, and research operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVILY_MAPTool to map a website and discover its pages. Use when you need to scan a website and get a structured list of URLs/pages it contains without extracting full content.

Input Parameters

string
required
The root URL to begin mapping (e.g., ‘docs.tavily.com’). This is the starting point from which the crawler will discover and map pages.
integer
Total number of links to process before stopping. Minimum is 1. Default is 50.
integer
Maximum number of seconds to wait for the mapping to complete. Range: 10-150. Default is 150.
integer
How far from the base URL the crawler explores. Range: 1-5. Default is 1.
integer
The number of links to follow per page level. Minimum is 1. Default is 20.
string
Natural language directions for the crawler to guide its exploration. Using this parameter raises the cost to 2 credits per 10 pages instead of 1.
array
List of regex patterns for specific URL paths to include (e.g., ‘/docs/.*’ to only include documentation paths).
array
List of regex patterns to skip certain URL paths (e.g., ‘/admin/.*’ to exclude admin pages).
boolean
If true, includes credit usage details in the response. Default is false.
boolean
If true, includes external domain links in the results. Default is true.
array
List of regex patterns for domain targeting. Only URLs matching these domain patterns will be included.
array
List of regex patterns to exclude certain domains from the mapping results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TAVILY_SEARCHSearch the web via Tavily with controls for search depth, result count, and domain filtering. Results can include images, an answer, and raw page content. Managed requests support basic depth only.Instant: Supported on the latest version.Instant pricing: $0.008 per web search.Discount: 50

Input Parameters

string
required
The search query string to find relevant information online. No native date-filter exists; embed time hints directly in the query string. For broad coverage, issue multiple focused queries rather than one broad query.
integer
Maximum number of search results to return. Large values combined with include_raw_content=true produce very large payloads.
string ("basic" | "advanced")
Specifies search depth: ‘basic’ (standard) or ‘advanced’ (in-depth; costs twice the basic price).
boolean
If true, attempts to include a direct answer to the query (suitable for factual questions) in search results. The answer field can be null; treat response_data.results array as primary evidence.
boolean
If true, includes links to relevant images in search results.
array
A list of domain names (e.g., ['exclude.com', 'othersite.net']) to exclude from search results; results from these domains will be filtered out.
array
A list of specific domain names (e.g., ['example.com', 'website.org']) to restrict the search to; only results from these domains are returned.
boolean
If true, includes raw content from visited websites (e.g., unprocessed HTML or text) in search results. Without this, results may be short snippets that omit critical detail.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not