網路搜尋

建立網站地圖

從根網址探索網站連結圖並回傳發現的 URL。這是 discovery-only 端點，不含內容擷取欄位。使用 Bearer API 金鑰，或將 api_key 放在 JSON body 作為相容性回退；支援 https://api.bazaarlink.ai/v1 與 https://bazaarlink.ai/api/v1。未知欄位會被忽略。回應包含 base_url、results URL 陣列、response_time、我們加上的 usage.credits、usage.cost（依管理員設定的每 credit 價格計算）與 request_id。每 10 個成功頁面基本收取 1 credit；提供 instructions 時為 2 credits。失敗頁面不收費。實際 credits 從共用每日免費額度扣除；若依 limit 預估超過剩餘額度，超出部分從餘額收費，無餘額則回傳 432 並建議降低 limit。 SDK 範例；請將金鑰放在環境變數或其他安全的伺服器端設定中。 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

驗證

Authorization必填

string · header

在 Authorization 標頭以 Bearer token 傳入 API 金鑰。

Body

url必填

string

要開始建立地圖的根網址；可省略 scheme，例如 docs.tavily.com。

required; scheme optional

Example: "docs.tavily.com"

instructions

string

告訴探索器要尋找的內容；提供後每 10 個成功頁面的 mapping 成本為 2 credits，而非 1。

Example: "Find Python SDK pages"

max_depth

integer

建立地圖的最大深度，範圍 1–5，預設 1。

1-5; default: 1

Example: 1

max_breadth

integer

每一層每頁最多跟隨的連結數，範圍 1–500，預設 20。

1-500; default: 20

Example: 20

limit

integer

在停止前最多處理的連結總數，至少 1，預設 50。

minimum: 1; default: 50

Example: 50

select_paths

string[]

選取路徑的正規表示式陣列；最多 50 個項目，每個正規表示式最多 200 個字元。

max 50 entries; max 200 characters per regex

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

select_domains

string[]

選取網域的正規表示式陣列；最多 50 個項目，每個正規表示式最多 200 個字元。

max 50 entries; max 200 characters per regex

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

exclude_paths

string[]

排除路徑的正規表示式陣列；最多 50 個項目，每個正規表示式最多 200 個字元。

max 50 entries; max 200 characters per regex

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

exclude_domains

string[]

排除網域的正規表示式陣列；最多 50 個項目，每個正規表示式最多 200 個字元。

max 50 entries; max 200 characters per regex

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

allow_external

boolean

是否將外部網域連結納入結果，預設 true。

default: true

Example: true

timeout

number

等待建立地圖的秒數。Tavily 範圍是 10–150，但 BazaarLink 有效上限為 90 秒；超過 90 會降為 90。

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

Example: 90

include_usage

boolean

是否在回應中包含 usage，預設 false；包含時會顯示 credits 與 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
  }'

回應範例

建立地圖成功。results 是發現的 URL 字串；每 10 個成功頁面基本成本 1 credit，提供 instructions 時為 2 credits。

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