Skip to main content
POST
Generate comprehensive site maps using Tavily Map.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
url
string
required

The root URL to begin the mapping.

Example:

"docs.tavily.com"

instructions
string

Natural language instructions for the crawler.

max_depth
integer
default:1

Max depth of the mapping.

Required range: 1 <= x <= 5
max_breadth
integer
default:20

Max number of links to follow per level of the tree.

Required range: 1 <= x <= 500
limit
integer
default:50

Total number of links the crawler will process before stopping.

Required range: x >= 1
select_paths
string[]

Regex patterns to select only URLs with specific path patterns.

select_domains
string[]

Regex patterns to select crawling to specific domains or subdomains.

exclude_paths
string[]

Regex patterns to exclude URLs with specific path patterns.

exclude_domains
string[]

Regex patterns to exclude specific domains or subdomains from mapping.

allow_external
boolean
default:true

Include external domain links in the final results list.

timeout
number<float>
default:150

Maximum time in seconds to wait for the map operation.

Required range: 10 <= x <= 150
include_usage
boolean
default:false

Include credit usage information in the response.

Response

200 - application/json

Map results returned successfully.

base_url
string

The base URL that was mapped.

results
string[]

URLs discovered during the mapping.

response_time
number<float>

Time in seconds it took to complete the request.

usage
object
request_id
string

Unique request identifier.