Connecting to Tavily

Using API Key Authentication

To authenticate with Tavily, you need to obtain an API key from your Tavily account dashboard. Tavily provides AI-powered web search capabilities with real-time, accurate, and factual results.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Tavily API key obtained from your account dashboard.

Example connection string:

Profile=C:\profiles\Tavily.apip;AuthScheme=APIKey;ProfileSettings='ApiKey=your_project_api_key';

Available Tables

The Tavily API Profile provides access to the following search, extraction, and account tables:

• Search - Retrieve web search results using Tavily's AI-powered search engine, with filtering by topic, search depth, publish date range, and included or excluded domains.
• Extract - Extract raw content from up to 20 URLs simultaneously using Tavily's content extraction engine.
• Crawl - Crawl websites using Tavily's graph-based traversal tool, which explores linked pages in parallel with configurable depth, breadth, and path or domain filters.
• Map - Map a website's structure, discovering and listing the URLs reachable from a base URL.
• Usage - Retrieve Tavily API usage statistics, including key usage, plan limits, and pay-as-you-go information.

Usage Examples

Search

Basic web search:

SELECT * FROM Search WHERE Query = 'latest AI research breakthroughs'

Search with topic, depth, and time range filters:

SELECT * FROM Search
WHERE Query = 'stock market news'
  AND Topic = 'finance'
  AND SearchDepth = 'advanced'
  AND MaxResults = 10
  AND TimeRange = 'week'

Extract

Extract content from multiple URLs:

SELECT * FROM Extract
WHERE Urls = 'https://example.com,https://example.org'
  AND Format = 'markdown'

Crawl

Crawl a site excluding private and admin paths:

SELECT * FROM Crawl
WHERE Url = 'https://example.com'
  AND MaxDepth = 2
  AND Limit = 50
  AND ExcludePaths = '/admin/.*,/private/.*'

Map

Map a site's documentation paths:

SELECT * FROM Map
WHERE Url = 'https://example.com'
  AND MaxDepth = 2
  AND SelectPaths = '/docs/.*'

Usage

Check current API key and plan usage:

SELECT * FROM Usage

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

---

Property	Description
APIKey	The API Key for your Tavily account.
AuthScheme	The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT, OAUTH_PASSWORD