Authorizations
Bearer authentication header in the form Bearer <token>, where <token> is your Tavily API key (e.g., Bearer tvly-YOUR_API_KEY).
Body
Parameters for the Tavily Map request.
The root URL to begin the mapping.
"docs.tavily.com"
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.
"Find all pages about the Python SDK"
Max depth of the mapping. Defines how far from the base URL the crawler can explore.
x >= 1
Max number of links to follow per level of the tree (i.e., per page).
x >= 1
Total number of links the crawler will process before stopping.
x >= 1
Regex patterns to select only URLs with specific path patterns (e.g., /docs/.*
, /api/v1.*
).
Regex patterns to select crawling to specific domains or subdomains (e.g., ^docs\.example\.com$
).
Regex patterns to exclude URLs with specific path patterns (e.g., /private/.*
, /admin/.*
).
Regex patterns to exclude specific domains or subdomains from crawling (e.g., ^private\.example\.com$
).
Whether to include external domain links in the final results list.
Response
Map results returned successfully
The base URL that was mapped.
"docs.tavily.com"
A list of URLs that were discovered during the mapping.
[
"https://docs.tavily.com/welcome",
"https://docs.tavily.com/documentation/api-credits",
"https://docs.tavily.com/documentation/about"
]
Time in seconds it took to complete the request.
1.23
A unique request identifier you can share with customer support to help resolve issues with specific requests.
"123e4567-e89b-12d3-a456-426614174111"