Tavily icon

Tavily

Tavily API

Overview

This node performs a search query using the Tavily API, allowing users to retrieve search results based on a variety of customizable parameters. It is useful for scenarios where users want to gather information from the web, including news, finance, or general topics, with options to control the depth, scope, and type of results returned. For example, it can be used to fetch recent news articles about a specific event, gather financial data, or perform a general web search with detailed content snippets.

Use Case Examples

  1. Search for recent news articles about a specific topic within the last week.
  2. Perform a general web search with advanced depth to retrieve detailed content chunks from multiple sources.
  3. Fetch financial news with a fast search depth and include images and their descriptions in the results.

Properties

Name Meaning
Query The search query string to be executed.
Options Various optional parameters to customize the search behavior, including topic, search depth, number of chunks per source, maximum results, time range, days for news topic, inclusion of LLM-generated answers, raw content, images, image descriptions, domain filters, favicon inclusion, auto parameter configuration, date range, country boost, and usage information.

Output

JSON

  • results - Array of search result objects containing information such as title, URL, snippet, and other metadata.
  • answer - An optional LLM-generated answer to the query, if requested.
  • usage - Credit usage information included if requested.

Dependencies

  • Tavily API key credential for authentication

Troubleshooting

  • Ensure the API key credential is correctly configured and has sufficient permissions to perform search queries.
  • Verify that the query string is not empty and follows expected formatting.
  • Check that date parameters (start_date, end_date) are in the correct YYYY-MM-DD format.
  • If using domain filters, ensure domain names are valid and correctly formatted.
  • Be aware of rate limits or usage quotas imposed by the Tavily API, which may cause errors if exceeded.

Links

Discussion