Generate comprehensive site maps using Tavily Map.
Web Content
Web crawling, URL discovery and page extraction.
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.
- 型: stringurl必須
The root URL to begin the mapping.
- 型: booleanallow
_external Include external domain links in the final results list.
- 型: array string[]exclude
_domains Regex patterns to exclude specific domains or subdomains from mapping.
- 型: array string[]exclude
_paths Regex patterns to exclude URLs with specific path patterns.
- 型: booleaninclude
_usage Include credit usage information in the response.
- 型: stringinstructions
Natural language instructions for the crawler.
- 型: integerlimit最小値:1
Total number of links the crawler will process before stopping.
- 型: integermax
_breadth 最小値:1最大値:500Max number of links to follow per level of the tree.
- 型: integermax
_depth 最小値:1最大値:5Max depth of the mapping.
- 型: array string[]select
_domains Regex patterns to select crawling to specific domains or subdomains.
- 型: array string[]select
_paths Regex patterns to select only URLs with specific path patterns.
- 型: number 形式: floattimeout最小値:10最大値:150
Maximum time in seconds to wait for the map operation.
- 型: object200
Map results returned successfully.
- 型: stringbase
_url The base URL that was mapped.
- 型: stringrequest
_id Unique request identifier.
- 型: number 形式: floatresponse
_time Time in seconds it took to complete the request.
- 型: array string[]results
- 型: objectusage
- credits型: integer
Credit usage details for the request.
application/json - 400
The request could not be processed. Check the request parameters.
- 401
A valid Felo API key is required.
- 402
The request cannot proceed because a billing requirement is not met.
- 403
The account is not permitted to perform this operation.
- 429
A request or spending limit has been reached.
- 502
The service could not complete the request.
- 503
The API or billing service is temporarily unavailable.
- 504
The service timed out while processing the request.
- default
The operation failed. Keep the response request ID when contacting Felo support.
curl https://openapi.felo.ai/v1/beta/tavily/map \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"url": "docs.tavily.com",
"instructions": "",
"max_depth": 1,
"max_breadth": 20,
"limit": 50,
"select_paths": [
""
],
"select_domains": [
""
],
"exclude_paths": [
""
],
"exclude_domains": [
""
],
"allow_external": true,
"timeout": 150,
"include_usage": false
}'
{
"base_url": "string",
"results": [
"string"
],
"response_time": 1,
"usage": {
"credits": 1
},
"request_id": "string"
}