Tavily integration (AI, Data). Imported from open-connector.
https://api.tavily.com/search
| Param | Type | Required | Description |
|---|---|---|---|
| query | string | required | The search query to execute with Tavily. |
| search_depth | string | optional | Controls the latency-versus-relevance tradeoff for Tavily Search. |
| chunks_per_source | integer | optional | The maximum number of chunks to return per source. |
| max_results | integer | optional | The maximum number of search results to return. |
| topic | string | optional | The search category used by Tavily. |
| time_range | string | optional | The date range shortcut used to filter results. |
| start_date | string | optional | Only return results after this YYYY-MM-DD date. |
| end_date | string | optional | Only return results before this YYYY-MM-DD date. |
| include_answer | boolean | optional | — |
| include_raw_content | boolean | optional | — |
| include_images | boolean | optional | Whether to include top-level and per-result images. |
| include_image_descriptions | boolean | optional | Whether to include descriptions for returned images. |
| include_favicon | boolean | optional | Whether to include favicons for returned results. |
| include_domains | array | optional | Domains that Tavily should include in the search results. |
| exclude_domains | array | optional | Domains that Tavily should exclude from the search results. |
| country | string | optional | A country name used to boost results for general searches. |
| auto_parameters | boolean | optional | Whether Tavily should auto-configure search parameters. |
| exact_match | boolean | optional | Whether Tavily should require quoted exact phrases to match exactly. |
| include_usage | boolean | optional | Whether to include credit usage details in the response. |
/extract
| Param | Type | Required | Description |
|---|---|---|---|
| urls | array | required | The URLs that Tavily should extract content from. |
| query | string | optional | An optional query used to rerank extracted chunks. |
| chunks_per_source | integer | optional | The maximum number of chunks to return per source when query is provided. |
| extract_depth | string | optional | Controls whether Tavily uses basic or advanced extraction. |
| include_images | boolean | optional | Whether to include images found on each page. |
| include_favicon | boolean | optional | Whether to include the favicon URL for each page. |
| format | string | optional | The format of the extracted page content. |
| timeout | number | optional | The extraction timeout in seconds. |
| include_usage | boolean | optional | Whether to include credit usage details in the response. |
/map
| Param | Type | Required | Description |
|---|---|---|---|
| url | string | required | The root URL that Tavily should map. |
| instructions | string | optional | Natural-language instructions that guide the mapping. |
| max_depth | integer | optional | The maximum mapping depth. |
| max_breadth | integer | optional | The maximum number of links to follow per level. |
| limit | integer | optional | The maximum number of links Tavily should process. |
| select_paths | array | optional | Regex patterns used to include only matching URL paths. |
| select_domains | array | optional | Regex patterns used to include only matching domains. |
| exclude_paths | array | optional | Regex patterns used to exclude matching URL paths. |
| exclude_domains | array | optional | Regex patterns used to exclude matching domains. |
| allow_external | boolean | optional | Whether external domain links can appear in the results. |
| timeout | number | optional | The mapping timeout in seconds. |
| include_usage | boolean | optional | Whether to include credit usage details in the response. |
/crawl
| Param | Type | Required | Description |
|---|---|---|---|
| url | string | required | The root URL that Tavily should crawl. |
| instructions | string | optional | Natural-language instructions that guide the crawl. |
| max_depth | integer | optional | The maximum crawl depth. |
| max_breadth | integer | optional | The maximum number of links to follow per crawl level. |
| limit | integer | optional | The maximum number of links Tavily should process. |
| select_paths | array | optional | Regex patterns used to include only matching URL paths. |
| select_domains | array | optional | Regex patterns used to include only matching domains. |
| exclude_paths | array | optional | Regex patterns used to exclude matching URL paths. |
| exclude_domains | array | optional | Regex patterns used to exclude matching domains. |
| allow_external | boolean | optional | Whether external domain links can appear in the results. |
| include_images | boolean | optional | Whether to include images in crawled results. |
| extract_depth | string | optional | Controls whether Tavily uses basic or advanced extraction. |
| format | string | optional | The format of the extracted page content. |
| include_favicon | boolean | optional | Whether to include a favicon URL for each crawled result. |
| timeout | number | optional | The crawl timeout in seconds. |
| include_usage | boolean | optional | Whether to include credit usage details in the response. |
/research
| Param | Type | Required | Description |
|---|---|---|---|
| input | string | required | The research task or question to investigate. |
| model | string | optional | Research model to use. |
| stream | boolean | optional | Must be false or omitted. Tavily SSE streaming is not supported. |
| output_schema | object | optional | JSON Schema for structured research output. |
| citation_format | string | optional | The format for citations in the research report. |
| include_domains | array | optional | Soft source preference domains. |
| exclude_domains | array | optional | Hard source blocklist domains. |
| output_length | string | optional | The target research response length. |
| files | array | optional | Up to 5 .txt, .md, or .json files to use as additional research sources. |
/research/{request_id}
| Param | Type | Required | Description |
|---|---|---|---|
| request_id | string | required | The unique identifier of the research task. |
/usage