Data API / Tavily / Map

Generate comprehensive site maps using Tavily Map.

List a site's URLs from a root url without fetching any page content. Steer it with natural-language instructions and regex select_paths / exclude_paths / select_domains filters. Returns base_url and results — a flat array of URL strings, not objects — with response_time and request_id. Use it to size a site before committing to a crawl, then fetch only the parts that matter with extractWebContent. When you want the content rather than the shape, post_tavily_crawl does both in one call.

Parameters

No path, query, or header parameters.

Request body

urlstringRequired
The root URL to begin the mapping.
instructionsstringOptional
Natural language instructions for the crawler.
max_depthintegerOptional
Max depth of the mapping.
max_breadthintegerOptional
Max number of links to follow per level of the tree.
limitintegerOptional
Total number of links the crawler will process before stopping.
select_pathsstring[]Optional
Regex patterns to select only URLs with specific path patterns.
select_domainsstring[]Optional
Regex patterns to select crawling to specific domains or subdomains.
exclude_pathsstring[]Optional
Regex patterns to exclude URLs with specific path patterns.
exclude_domainsstring[]Optional
Regex patterns to exclude specific domains or subdomains from mapping.
allow_externalbooleanOptional
Include external domain links in the final results list.
timeoutnumberOptional
Maximum time in seconds to wait for the map operation.
include_usagebooleanOptional
Include credit usage information in the response.

Example request

curl -X POST "https://openapi.felo.ai/v1/beta/tavily/map" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "<string>",
  "instructions": "<string>",
  "max_depth": 0,
  "max_breadth": 0,
  "limit": 0,
  "select_paths": [
    "<string>"
  ],
  "select_domains": [
    "<string>"
  ],
  "exclude_paths": [
    "<string>"
  ]
}'

Response

Response fields

base_urlstringOptional
The base URL that was mapped.
resultsstring[]Optional
response_timenumberOptional
Time in seconds it took to complete the request.
usageobjectOptional
creditsintegerOptional
Credit usage details for the request.
request_idstringOptional
Unique request identifier.