データ 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.

パラメータ

パス・クエリ・ヘッダーのパラメータはありません。

リクエストボディ

urlstring必須
The root URL to begin the mapping.
instructionsstring任意
Natural language instructions for the crawler.
max_depthinteger任意
Max depth of the mapping.
max_breadthinteger任意
Max number of links to follow per level of the tree.
limitinteger任意
Total number of links the crawler will process before stopping.
select_pathsstring[]任意
Regex patterns to select only URLs with specific path patterns.
select_domainsstring[]任意
Regex patterns to select crawling to specific domains or subdomains.
exclude_pathsstring[]任意
Regex patterns to exclude URLs with specific path patterns.
exclude_domainsstring[]任意
Regex patterns to exclude specific domains or subdomains from mapping.
allow_externalboolean任意
Include external domain links in the final results list.
timeoutnumber任意
Maximum time in seconds to wait for the map operation.
include_usageboolean任意
Include credit usage information in the response.

リクエスト例

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>"
  ]
}'

レスポンス

レスポンスのフィールド

base_urlstring任意
The base URL that was mapped.
resultsstring[]任意
response_timenumber任意
Time in seconds it took to complete the request.
usageobject任意
creditsinteger任意
Credit usage details for the request.
request_idstring任意
Unique request identifier.