Tavily Python SDK

0.7.23 · active · verified Thu Apr 09

The `tavily-python` library provides a Python wrapper for the Tavily API, enabling easy integration of web search, content extraction, crawling, mapping, and research functionalities into Python applications. It supports both synchronous and asynchronous clients. The library is under active development with frequent updates, with its current version being 0.7.23.

Warnings

deprecated The `langchain_community.tools.tavily_search.tool` has been deprecated in favor of the new `langchain-tavily` Python package. This new package supports Search, Extract, Map, and Crawl functionality and receives continuous updates.
Fix: Migrate to `langchain-tavily` by installing `pip install -U langchain-tavily` and updating your LangChain integrations.
gotcha Failure to provide a valid Tavily API key during client instantiation will result in a `tavily.MissingAPIKeyError`. The API key is essential for all API interactions.
Fix: Ensure `api_key` is passed to `TavilyClient` or `AsyncTavilyClient` constructor, preferably via an environment variable (e.g., `TAVILY_API_KEY`).
gotcha Intermittent HTTP 400 Client Errors or 500 Server Errors have been reported by users, often related to API outages or invalid/expired API keys.
Fix: Regenerate your API key on the Tavily platform dashboard and retry. Check the Tavily status page or community for service announcements.
gotcha Using `auto_parameters=True` in the `search` method might automatically set `search_depth` to `advanced`, which can consume more API credits (2 API credits instead of 1 for `basic`).
Fix: To avoid unexpected costs, explicitly set `search_depth='basic'` or monitor credit usage when `auto_parameters` is enabled.

Install

pip install tavily-python Install with pip

Imports

TavilyClient
```
from tavily import TavilyClient
```
Use this for synchronous API calls.
AsyncTavilyClient
```
from tavily import AsyncTavilyClient
```
Use this for asynchronous API calls.
MissingAPIKeyError
```
from tavily import MissingAPIKeyError
```
Import for handling specific API key related exceptions.

Quickstart

This quickstart initializes the TavilyClient with an API key from an environment variable and performs a basic search query. It includes a check to ensure the API key is provided, which is crucial for successful API calls.

import os
from tavily import TavilyClient

tavily_client = TavilyClient(api_key=os.environ.get('TAVILY_API_KEY', ''))

if not tavily_client.api_key:
    raise ValueError("TAVILY_API_KEY environment variable not set. Get your key from tavily.com.")

response = tavily_client.search("What is the capital of France?")
print(response)

view raw JSON →