Tavily Site Map

Name: Tavily Site Map
Price: 0.012 USD
Availability: InStock
Author: Tavily

https://api.sandbase.ai/v1/api/tavily/map

Discovers the URL structure of a target website without extracting full page content. Accepts a starting URL, maximum traversal depth, and URL discovery limits.

Try this API Get API key

Price: $0.01USD / call
Method: POST
Response: JSON
Parameters: 1 required · 2 optional

Production route

Try the model

Playground

Open playground

Input

URL(string)

The starting URL to map.

Max Depth(integer)

Maximum traversal depth from the starting URL. Range: 1 to 5.

Limit(integer)

11000

Maximum number of URLs to discover. Range: 1 to 1000.

OutputExample

Responseoutputs · 1.5 KB · 17 lines

{
  "base_url": "https://static.sandbase.ai/examples/b1ca8e2d-8fe7-4358-99d8-4dac64d43e91/output/d074facb-a5df-4233-a4c1-223f9367b21c.com",
  "request_id": "0667ef21-2631-4422-a5bf-cde05b0cd663",
  "response_time": 0.09,
  "results": [
    "https://static.sandbase.ai/examples/b1ca8e2d-8fe7-4358-99d8-4dac64d43e91/output/d862898d-0dbb-4e43-8eb8-e5cb4bd32747.bin",
    "https://static.sandbase.ai/examples/b1ca8e2d-8fe7-4358-99d8-4dac64d43e91/output/5749e619-f363-4045-b3f1-9ecd37412b81.bin",
    "https://static.sandbase.ai/examples/b1ca8e2d-8fe7-4358-99d8-4dac64d43e91/output/bbc5f220-7079-4a2d-9e00-7e31ae1d9b6d.bin",
    "https://static.sandbase.ai/examples/b1ca8e2d-8fe7-4358-99d8-4dac64d43e91/output/02743b37-0bea-4e73-a603-6b4320f9922f.txt",
    "https://static.sandbase.ai/examples/b1ca8e2d-8fe7-4358-99d8-4dac64d43e91/output/eef26394-1bf1-4fa0-ad47-3b6c1aebc608.bin",
    "https://static.sandbase.ai/examples/b1ca8e2d-8fe7-4358-99d8-4dac64d43e91/output/5b0cd1d6-d7b9-4db5-9ed7-5e69848c214a.bin",
    "https://static.sandbase.ai/examples/b1ca8e2d-8fe7-4358-99d8-4dac64d43e91/output/dbefa0cd-c2a5-444f-a820-a953024669ee.bin",
    "https://static.sandbase.ai/examples/b1ca8e2d-8fe7-4358-99d8-4dac64d43e91/output/64aaf676-5552-4bfa-a967-83db1ee42fe1.bin",
    "https://static.sandbase.ai/examples/b1ca8e2d-8fe7-4358-99d8-4dac64d43e91/output/dbf7c5cd-d7cf-48df-854b-1ca3d9b9fc1b.bin",
    "https://static.sandbase.ai/examples/b1ca8e2d-8fe7-4358-99d8-4dac64d43e91/output/eb734a67-5385-425e-8adf-be5f3de698e0.bin"
  ]
}

Examples

Select an example to load its inputs and result into the playground.

Model card

Specifications

Pricing

Base price: $0.01 / run

Request & response

Method: POST
Request body: application/json
Response: application/json
Execution: sync

Parameters

url: string · required
max_depth: integer · optional
limit: integer · optional

Access

Provider: Tavily
API: Platform API
Base URL: https://api.sandbase.ai
Endpoint: /v1/api/tavily/map
Authentication: Bearer API key

API README

Tavily Site Map API

Maps website URL structures starting from a target url. Controls discovery bounds using optional limit and max_depth parameters.

Use cases

Map domain architectures before targeted content extraction.
Discover all accessible subpages across a specific website.
Audit site navigation depth and internal link structures.

Request

curl -X POST "https://api.sandbase.ai/v1/api/tavily/map" \
  -H "Authorization: Bearer $SANDBASE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "<url>"}'

Parameters

Name	Type	Required	Description
`url`	string	Yes	The starting URL to map.
`limit`	integer	No	Maximum number of URLs to discover.
`max_depth`	integer	No	Maximum traversal depth from the starting URL.

Notes

Configure limit to restrict the maximum number of discovered URLs.
Use max_depth to define how many levels deep traversal continues from url.

Start building

Send your first request

Platform API endpoint with unified authentication and usage tracking.

Production API

Platform API endpoint

https://api.sandbase.ai/v1/api/tavily/map

Authorization header

Authorization: Bearer $SANDBASE_API_KEY

# The quoted heredoc keeps Unicode and shell metacharacters unchanged.
result=$(curl --fail-with-body --silent \
  -X POST "https://api.sandbase.ai/v1/api/tavily/map" \
  -H "Authorization: Bearer $SANDBASE_API_KEY" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'SANDBASE_JSON'
{
  "limit": 10,
  "url": "https://static.sandbase.ai/examples/b1ca8e2d-8fe7-4358-99d8-4dac64d43e91/input/73ac2081-9c93-4d56-a0c0-0d23d590e501.com"
}
SANDBASE_JSON
)
printf '%s\n' "$result"

Explore more

Related APIs

All APIs

API	Price	Response	Released
Tavily Site MapThis API `Tavily`	$0.01 per call	JSON	Jan 1, 2024
Tavily URL Content Extraction `Tavily`	$0.01 per call	JSON	Jan 1, 2024
Tavily Search `Tavily`	$0.01 per call	JSON	Jan 1, 2024

Questions

FAQ

How do I use the Tavily Site Map API?

Send a POST request to https://api.sandbase.ai/v1/api/tavily/map with your SandBase API key in the Authorization header (Bearer) and the parameters as a JSON body. You can also try it in the Playground on this page without writing code.

How much does the Tavily Site Map API cost?

$0.01 per call, billed from your SandBase balance. You are only charged for calls you make; there is no subscription.

What parameters does the Tavily Site Map API accept?

Required: url (string). Optional: max_depth (integer) and limit (integer). The Parameters table and the Playground on this page list every field.

What does the Tavily Site Map API return?

A JSON response returned in the same HTTP request (synchronous).

Do I need a Tavily developer account or API key?

No. Tavily Site Map runs through SandBase, so one SandBase API key covers this endpoint and every other API and model in the catalog. You do not need to apply for Tavily API access separately.