Tài liệu Tham chiếu API Tham chiếu SDK Sử dụng Agent Kỹ năng AI

Tìm kiếm web

Lập bản đồ URL website

Khám phá đồ thị liên kết của website từ URL gốc và trả về các URL được phát hiện. Đây là endpoint chỉ discovery, không có trường trích xuất nội dung. Xác thực bằng Bearer API key hoặc truyền api_key trong JSON body làm phương án tương thích; hỗ trợ cả hai base URL. Trường không nhận biết bị bỏ qua. Phản hồi gồm base_url, mảng URL results, response_time, usage.credits và usage.cost bổ sung theo đơn giá mỗi credit do quản trị viên đặt, cùng request_id. Mapping tốn 1 credit cho mỗi 10 trang thành công, hoặc 2 credit khi có instructions; trang thất bại được miễn phí. Credit thực tế trừ từ hạn mức miễn phí hằng ngày dùng chung. Nếu ước tính theo limit vượt phần còn lại, phần vượt tính vào số dư, hoặc trả 432 khi không có số dư và khuyên giảm limit. Ví dụ SDK; hãy giữ khóa trong biến môi trường hoặc một cấu hình an toàn phía máy chủ khác. 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

Xác thực

Authorizationbắt buộc

string · header

API key dưới dạng bearer token trong header Authorization.

Body

urlbắt buộc

string

URL gốc để lập bản đồ; có thể bỏ scheme, ví dụ docs.tavily.com.

required; scheme optional

Example: "docs.tavily.com"

instructions

string

Chỉ dẫn discovery bằng ngôn ngữ tự nhiên; chi phí mapping tăng lên 2 credit thay vì 1 cho mỗi 10 trang thành công.

Example: "Find Python SDK pages"

max_depth

integer

Độ sâu lập bản đồ tối đa, từ 1 đến 5, mặc định 1.

1-5; default: 1

Example: 1

max_breadth

integer

Số liên kết tối đa theo mỗi trang ở mỗi cấp, từ 1 đến 500, mặc định 20.

1-500; default: 20

Example: 20

limit

integer

Tổng số liên kết xử lý trước khi dừng; tối thiểu 1, mặc định 50.

minimum: 1; default: 50

Example: 50

select_paths

string[]

Mảng mẫu regex cho chọn đường dẫn; tối đa 50 mục, mỗi mẫu dài tối đa 200 ký tự.

max 50 entries; max 200 characters per regex

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

select_domains

string[]

Mảng mẫu regex cho chọn miền; tối đa 50 mục, mỗi mẫu dài tối đa 200 ký tự.

max 50 entries; max 200 characters per regex

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

exclude_paths

string[]

Mảng mẫu regex cho loại trừ đường dẫn; tối đa 50 mục, mỗi mẫu dài tối đa 200 ký tự.

max 50 entries; max 200 characters per regex

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

exclude_domains

string[]

Mảng mẫu regex cho loại trừ miền; tối đa 50 mục, mỗi mẫu dài tối đa 200 ký tự.

max 50 entries; max 200 characters per regex

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

allow_external

boolean

Có đưa liên kết ngoài miền vào kết quả cuối hay không, mặc định true.

default: true

Example: true

timeout

number

Số giây chờ lập bản đồ. Tavily cho phép 10–150 nhưng giới hạn hiệu dụng của BazaarLink là 90 giây; giá trị trên 90 được hạ xuống 90.

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

Example: 90

include_usage

boolean

Có đưa usage vào phản hồi hay không, mặc định false; khi có sẽ có credits và 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
  }'

Ví dụ phản hồi

Lập bản đồ hoàn tất. results chứa chuỗi URL được phát hiện; mỗi 10 trang thành công tốn 1 credit, hoặc 2 credit khi có instructions.

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