POST
/
map
curl --request POST \
  --url https://api.tavily.com/map \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "docs.tavily.com",
  "max_depth": 1,
  "max_breadth": 20,
  "limit": 50,
  "instructions": "Python SDK",
  "select_paths": null,
  "select_domains": null,
  "exclude_paths": null,
  "exclude_domains": null,
  "allow_external": false,
  "categories": null
}'
{
  "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
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header in the form Bearer <token>, where <token> is your Tavily API key (e.g., Bearer tvly-YOUR_API_KEY).

Body

application/json

Parameters for the Tavily Map request.

The body is of type object.

Response

200
application/json

Crawl results returned successfully

The response is of type object.