Docs API Reference SDK Reference Agentic Usage AI Skills

Web Search

Map website URLs

Explore a website link graph from a root URL and return the discovered URLs. This is a discovery-only endpoint: it has no content-extraction fields. Authenticate with a Bearer API key, or pass api_key in the JSON body as a compatibility fallback; both https://api.bazaarlink.ai/v1 and https://bazaarlink.ai/api/v1 are supported. Unknown fields are ignored. The response includes base_url, a results array of URL strings, response_time, our additive usage.credits and usage.cost (credits multiplied by the admin-set per-credit price), and our request_id. Mapping costs 1 credit per 10 successful pages, or 2 credits per 10 when instructions is provided; failed pages are free. Actual credits draw from the shared daily free allowance, and an estimate that exceeds the remainder is billed from balance or returns 432 without balance with a suggestion to lower limit. Mapping costs 1 credit per 10 successful pages, or 2 credits per 10 when instructions is provided; failed pages are free. Actual credits draw from the shared daily free allowance. If the estimate from limit exceeds the remainder, the excess is billed from balance, or the call returns 432 without balance and suggests lowering limit. SDK examples; keep the key in an environment variable or another secure server-side setting. Python: from tavily import TavilyClient client = TavilyClient(api_key="...", api_base_url="https://api.bazaarlink.ai/v1") response = client.map("docs.tavily.com") JavaScript: import { tavily } from "@tavily/core" const tvly = tavily({ apiKey: process.env.BAZAARLINK_API_KEY, apiBaseURL: "https://api.bazaarlink.ai/v1" }) const response = await tvly.map("docs.tavily.com")

POST/v1/map

Authorizations

Authorizationrequired

string · header

API key as bearer token in the Authorization header.

Body

urlrequired

string

Root URL for the map; the scheme is optional, for example docs.tavily.com.

required; scheme optional

Example: "docs.tavily.com"

instructions

string

Natural-language discovery instructions; they raise the mapping cost to 2 credits per 10 successful pages instead of 1.

Example: "Find Python SDK pages"

max_depth

integer

Maximum mapping depth, 1 to 5, default 1.

1-5; default: 1

Example: 1

max_breadth

integer

Maximum links followed per page at each level, 1 to 500, default 20.

1-500; default: 20

Example: 20

limit

integer

Total links processed before stopping; minimum 1, default 50.

minimum: 1; default: 50

Example: 50

select_paths

string[]

path selection regex patterns; at most 50 entries, with each pattern limited to 200 characters.

max 50 entries; max 200 characters per regex

Example: ["^/docs/.*"]

select_domains

string[]

domain selection regex patterns; at most 50 entries, with each pattern limited to 200 characters.

max 50 entries; max 200 characters per regex

Example: ["^docs\.example\.com$"]

exclude_paths

string[]

path exclusion regex patterns; at most 50 entries, with each pattern limited to 200 characters.

max 50 entries; max 200 characters per regex

Example: ["^/private/.*"]

exclude_domains

string[]

domain exclusion regex patterns; at most 50 entries, with each pattern limited to 200 characters.

max 50 entries; max 200 characters per regex

Example: ["^private\.example\.com$"]

allow_external

boolean

Whether to include external-domain links in the final results, default true.

default: true

Example: true

timeout

number

Seconds to wait for the map. Tavily's range is 10-150, but BazaarLink's effective maximum is 90 seconds; values above 90 are lowered to 90.

Tavily: 10-150; BazaarLink default/effective maximum: 90 seconds; values above 90 are lowered to 90

Example: 90

include_usage

boolean

Whether to include usage in the response, default false; when included it shows credits and usage.cost.

default: false

Example: false

POST /v1/map

1
2
3
4
5
6
7
curl https://api.bazaarlink.ai/v1/map   -H "Authorization: Bearer $BAZAARLINK_API_KEY"   -H "Content-Type: application/json"   -d '{
    "url": "docs.tavily.com",
    "instructions": "Find Python SDK pages",
    "limit": 20,
    "timeout": 90,
    "include_usage": true
  }'

Response examples

Mapping completed. results contains discovered URL strings; every 10 successful pages cost 1 credit, or 2 credits when instructions is provided.

1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "base_url": "docs.tavily.com",
  "results": [
    "https://docs.tavily.com/welcome",
    "https://docs.tavily.com/documentation/api-credits"
  ],
  "response_time": 1.23,
  "usage": {
    "credits": 1,
    "cost": 0.01
  },
  "request_id": "map_123e4567-e89b-12d3-a456-426614174111"
}