ドキュメント APIリファレンス SDKリファレンスエージェント利用 AIスキル

ウェブ検索

ウェブサイト URL をマップ

ルート URL からウェブサイトのリンクグラフを探索し、見つかった URL を返します。コンテンツ抽出フィールドを持たない discovery 専用エンドポイントです。Bearer API キー、または互換性のため JSON body の api_key を使えます。https://api.bazaarlink.ai/v1 と https://bazaarlink.ai/api/v1 の両方に対応します。未知のフィールドは無視されます。レスポンスには base_url、URL 文字列の results 配列、response_time、管理者設定の単価による追加フィールド usage.credits と usage.cost、request_id が含まれます。成功ページ 10 件ごとの mapping は基本 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 トークンとして API キーを渡します。

Body

url必須

string

マップを開始するルート URL。scheme は省略でき、例は docs.tavily.com です。

required; scheme optional

Example: "docs.tavily.com"

instructions

string

探索への自然言語指示。指定すると成功ページ 10 件ごとの mapping コストが 1 ではなく 2 credits になります。

Example: "Find Python SDK pages"

max_depth

integer

マッピングの最大深度。1～5、既定値は 1 です。

1-5; default: 1

Example: 1

max_breadth

integer

各レベルで 1 ページあたりに追跡するリンク数。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[]

Domänenausschluss 用の正規表現配列です。最大 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"
}