Skip to main content
POST
/
map
Python SDK
from tavily import TavilyClient

tavily_client = TavilyClient(api_key="tvly-YOUR_API_KEY")
response = tavily_client.map("https://docs.tavily.com")

print(response)
{
  "base_url": "docs.tavily.com",
  "results": [
    "https://docs.tavily.com/welcome",
    "https://docs.tavily.com/documentation/api-credits",
    "https://docs.tavily.com/documentation/about"
  ],
  "response_time": 1.23,
  "request_id": "123e4567-e89b-12d3-a456-426614174111"
}
Beta Feature - The Tavily Map endpoint is currently in Beta. While fully functional, the API may undergo changes as we continue to refine and improve the service.

Authorizations

​
Authorization
string
header
required

Body

application/json
​
url
string
required
Example:
​
instructions
string
Example:
​
max_depth
integer
default:1
Required range: 1 <= x <= 5
​
max_breadth
integer
default:20
Required range: x >= 1
​
limit
integer
default:50
Required range: x >= 1
​
select_paths
string[]
​
select_domains
string[]
​
exclude_paths
string[]
​
exclude_domains
string[]
​
allow_external
boolean
default:true
​
timeout
number
default:150
Required range: 10 <= x <= 150

Response

​
base_url
string
Example:
​
results
string[]
Example:
​
response_time
number
Example:
​
request_id
string
Example: