Quickstart

Use tavily-python to call Tavily Search, Extract, Crawl, and Map from your Python programs. For every method and parameter, see the Python SDK reference.

Get an API key

Get a free Tavily API key. You get 1,000 free API credits every month, and no credit card is required.

Install the SDK

pip install tavily-python

Make your first search

from tavily import TavilyClient

tavily_client = TavilyClient(api_key="tvly-YOUR_API_KEY")
response = tavily_client.search("Who is Leo Messi?")

print(response)

More examples

Extract content from URLs:

from tavily import TavilyClient

tavily_client = TavilyClient(api_key="tvly-YOUR_API_KEY")
response = tavily_client.extract("https://en.wikipedia.org/wiki/Lionel_Messi")

print(response)

Run a smart crawl starting at a given URL:

from tavily import TavilyClient

tavily_client = TavilyClient(api_key="tvly-YOUR_API_KEY")
response = tavily_client.crawl("https://docs.tavily.com", instructions="Find all pages on the Python SDK")

print(response)

Features

Our Python SDK supports the full feature range of our REST API, and more. We offer both a synchronous and an asynchronous client, for increased flexibility.

The search function lets you harness the full power of Tavily Search.
The extract function allows you to easily retrieve web content with Tavily Extract.
The crawl and map functions allow you to intelligently traverse websites and extract content.

For more details, head to the Python SDK Reference.

Resources

GitHub

/tavily-ai/tavily-python

PyPI

tavily-python PyPI downloads

Get started

Coding agents

API keys & credits

Best practices

Help

More examples

Features

Resources

GitHub

PyPI

​More examples

​Features

​Resources

GitHub

PyPI

More examples

Features

Resources