POST/map

Tavily Map

Tavily Map traverses websites like a graph and can explore hundreds of paths in parallel with intelligent discovery to generate comprehensive site maps.

Tavily·Dynamic pricing

Dynamic pricing

ceil((body.limit ? body.limit : 50) / 10) * (body.instructions ? 0.02 : 0.01)

Example code

// Using @orth/sdk - The simplest way to call APIs
// Install: npm install @orth/sdk
import Orthogonal from "@orth/sdk";

const orthogonal = new Orthogonal({
  apiKey: process.env.ORTHOGONAL_API_KEY,
});

const output = await orthogonal.run({
  api: "tavily",
  path: "/map",
  body: {
    "url": "example"
  }
});

console.log(output);

Body parameters

urlrequired

string

The root URL to begin the mapping.

instructions

string

Natural language instructions for the crawler. When specified, the cost increases to 2 API credits per 10 successful pages instead of 1 API credit per 10 pages.

max_depth

integer

Max depth of the mapping. Defines how far from the base URL the crawler can explore.

max_breadth

integer

Max number of links to follow per level of the tree (i.e., per page).

limit

integer

Total number of links the crawler will process before stopping.

select_paths

string

Regex patterns to select only URLs with specific path patterns (e.g., /docs/.*, /api/v1.*).

select_domains

string

Regex patterns to select crawling to specific domains or subdomains (e.g., ^docs\.example\.com$).

exclude_paths

string

Regex patterns to exclude URLs with specific path patterns (e.g., /private/.*, /admin/.*).

exclude_domains

string

Regex patterns to exclude specific domains or subdomains from crawling (e.g., ^private\.example\.com$).

allow_external

boolean

Whether to include external domain links in the final results list.

timeout

number<float>

Maximum time in seconds to wait for the map operation before timing out. Must be between 10 and 150 seconds.

Response

results.0

string

base_url

string

request_id

string

response_time

number