← Tools Reference

Tavily

Tavily integration (AI, Data). Imported from open-connector.

API key7 toolshttps://api.tavily.com
POST
tavily_search
Execute a Tavily Search query and return ranked source results.

/search

19 parameters
ParamTypeRequiredDescription
querystringrequiredThe search query to execute with Tavily.
search_depthstringoptionalControls the latency-versus-relevance tradeoff for Tavily Search.
chunks_per_sourceintegeroptionalThe maximum number of chunks to return per source.
max_resultsintegeroptionalThe maximum number of search results to return.
topicstringoptionalThe search category used by Tavily.
time_rangestringoptionalThe date range shortcut used to filter results.
start_datestringoptionalOnly return results after this YYYY-MM-DD date.
end_datestringoptionalOnly return results before this YYYY-MM-DD date.
include_answerbooleanoptional
include_raw_contentbooleanoptional
include_imagesbooleanoptionalWhether to include top-level and per-result images.
include_image_descriptionsbooleanoptionalWhether to include descriptions for returned images.
include_faviconbooleanoptionalWhether to include favicons for returned results.
include_domainsarrayoptionalDomains that Tavily should include in the search results.
exclude_domainsarrayoptionalDomains that Tavily should exclude from the search results.
countrystringoptionalA country name used to boost results for general searches.
auto_parametersbooleanoptionalWhether Tavily should auto-configure search parameters.
exact_matchbooleanoptionalWhether Tavily should require quoted exact phrases to match exactly.
include_usagebooleanoptionalWhether to include credit usage details in the response.
POST
tavily_extract
Extract structured page content from one or more URLs with Tavily.

/extract

9 parameters
ParamTypeRequiredDescription
urlsarrayrequiredThe URLs that Tavily should extract content from.
querystringoptionalAn optional query used to rerank extracted chunks.
chunks_per_sourceintegeroptionalThe maximum number of chunks to return per source when query is provided.
extract_depthstringoptionalControls whether Tavily uses basic or advanced extraction.
include_imagesbooleanoptionalWhether to include images found on each page.
include_faviconbooleanoptionalWhether to include the favicon URL for each page.
formatstringoptionalThe format of the extracted page content.
timeoutnumberoptionalThe extraction timeout in seconds.
include_usagebooleanoptionalWhether to include credit usage details in the response.
POST
tavily_map
Discover URLs from a website with Tavily Map.

/map

12 parameters
ParamTypeRequiredDescription
urlstringrequiredThe root URL that Tavily should map.
instructionsstringoptionalNatural-language instructions that guide the mapping.
max_depthintegeroptionalThe maximum mapping depth.
max_breadthintegeroptionalThe maximum number of links to follow per level.
limitintegeroptionalThe maximum number of links Tavily should process.
select_pathsarrayoptionalRegex patterns used to include only matching URL paths.
select_domainsarrayoptionalRegex patterns used to include only matching domains.
exclude_pathsarrayoptionalRegex patterns used to exclude matching URL paths.
exclude_domainsarrayoptionalRegex patterns used to exclude matching domains.
allow_externalbooleanoptionalWhether external domain links can appear in the results.
timeoutnumberoptionalThe mapping timeout in seconds.
include_usagebooleanoptionalWhether to include credit usage details in the response.
POST
tavily_crawl
Crawl a website and extract content from discovered pages with Tavily.

/crawl

16 parameters
ParamTypeRequiredDescription
urlstringrequiredThe root URL that Tavily should crawl.
instructionsstringoptionalNatural-language instructions that guide the crawl.
max_depthintegeroptionalThe maximum crawl depth.
max_breadthintegeroptionalThe maximum number of links to follow per crawl level.
limitintegeroptionalThe maximum number of links Tavily should process.
select_pathsarrayoptionalRegex patterns used to include only matching URL paths.
select_domainsarrayoptionalRegex patterns used to include only matching domains.
exclude_pathsarrayoptionalRegex patterns used to exclude matching URL paths.
exclude_domainsarrayoptionalRegex patterns used to exclude matching domains.
allow_externalbooleanoptionalWhether external domain links can appear in the results.
include_imagesbooleanoptionalWhether to include images in crawled results.
extract_depthstringoptionalControls whether Tavily uses basic or advanced extraction.
formatstringoptionalThe format of the extracted page content.
include_faviconbooleanoptionalWhether to include a favicon URL for each crawled result.
timeoutnumberoptionalThe crawl timeout in seconds.
include_usagebooleanoptionalWhether to include credit usage details in the response.
POST
tavily_create_research
Start an asynchronous Tavily Research task and return a request ID for polling.

/research

9 parameters
ParamTypeRequiredDescription
inputstringrequiredThe research task or question to investigate.
modelstringoptionalResearch model to use.
streambooleanoptionalMust be false or omitted. Tavily SSE streaming is not supported.
output_schemaobjectoptionalJSON Schema for structured research output.
citation_formatstringoptionalThe format for citations in the research report.
include_domainsarrayoptionalSoft source preference domains.
exclude_domainsarrayoptionalHard source blocklist domains.
output_lengthstringoptionalThe target research response length.
filesarrayoptionalUp to 5 .txt, .md, or .json files to use as additional research sources.
GET
tavily_get_research
Get the current status and result for a Tavily Research task.

/research/{request_id}

1 parameter
ParamTypeRequiredDescription
request_idstringrequiredThe unique identifier of the research task.
GET
tavily_get_usage
Get API key and account usage details from Tavily.

/usage