Quickstart

​

Introduction

The Python SDK allows for easy interaction with the Tavily API, offering the full range of our search functionality directly from your Python programs. Easily integrate smart search capabilities into your applications, harnessing Tavily’s powerful search features.

GitHub

/tavily-ai/tavily-python

PyPI

tavily-python

​

Quickstart

Get started with our Python SDK in less than 5 minutes!

​

Installation

You can install the Tavily Python SDK using the following:

pip install tavily-python

​

Usage

With Tavily’s Python SDK, you can search the web in only 4 lines of code:

from tavily import TavilyClient

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

print(response)

You can also easily 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)

Tavily also allows you to perform 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)

These examples are very simple, and you can do so much more with Tavily!

​

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 mapfunctions allow you to intelligently traverse websites and extract content.

For more details, head to the Python SDK Reference.