# Tavily Site Map API

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

Source: https://www.sandbase.ai/apis/tavily/map
API reference: https://www.sandbase.ai/apis/tavily/map/docs

## Facts

- Provider: Tavily
- Type: Data API
- Endpoint: `POST https://api.sandbase.ai/v1/api/tavily/map`
- Price: $0.01 per call
- Capabilities: site mapping, url discovery
- Billing: pay per use from one SandBase balance; no provider account or subscription needed

## Call it

`POST https://api.sandbase.ai/v1/api/tavily/map` with `Authorization: Bearer $SANDBASE_API_KEY` and the parameters as a JSON body.

| Parameter | Type | Required | Allowed values |
| --- | --- | --- | --- |
| `url` | string | yes |  |
| `max_depth` | integer | no |  |
| `limit` | integer | no |  |

## 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.

## 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

```bash
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`.