Tavily · Search

Tavily Search and Extract API / Initiate a web mapping from a base URL

Tavily Map traverses websites like a graph and can explore hundreds of paths in parallel with intelligent discovery to generate comprehensive site maps.

Private Gateway connection

Data below comes from the configured private Gateway. Provider activation remains governed by its evidence and policy gates.

unverifiedRequest shape unavailableUnverified

Published API evidence

Public metadata only. Response bodies, credentials, and internal review notes are never displayed.

No verification date is claimed. No response capture is claimed.

Request parameters

allow_external body · optional
Whether to include external domain links in the final results list.
exclude_domains body · optional
Regex patterns to exclude specific domains or subdomains from crawling (e.g., `^private\.example\.com$`).
exclude_paths body · optional
Regex patterns to exclude URLs with specific path patterns (e.g., `/private/.*`, `/admin/.*`).
include_usage body · optional
Whether to include credit usage information in the response.`NOTE:`The value may be 0 if the total successful pages mapped has not yet reached 10 calls. See our [Credits & Pricing documentation](https://docs.tavily.com/documentation/api-credits) for details.
instructions body · optional
Natural language instructions for the crawler. When specified, the cost increases to 2 API credits per 10 successful pages instead of 1 API credit per 10 pages. Example: "Find all pages about the Python SDK"
limit body · optional
Total number of links the crawler will process before stopping.
max_breadth body · optional
Max number of links to follow per level of the tree (i.e., per page).
max_depth body · optional
Max depth of the mapping. Defines how far from the base URL the crawler can explore.
select_domains body · optional
Regex patterns to select crawling to specific domains or subdomains (e.g., `^docs\.example\.com$`).
select_paths body · optional
Regex patterns to select only URLs with specific path patterns (e.g., `/docs/.*`, `/api/v1.*`).
timeout body · optional
Maximum time in seconds to wait for the map operation before timing out. Must be between 10 and 150 seconds.
url body · required
The root URL to begin the mapping. Example: "docs.tavily.com"

Provider docs How to run it