帳戶

建立 Tavily 研究工作

非同步建立研究工作。OpenAPI 的必要輸入欄位是 input（不是 query）；model 可選 mini、pro 或 auto，stream=true 時會以 SSE 傳送結果。Bearer 是偏好的驗證方式，也可在 JSON body 以可選 api_key 驗證。研究按實際使用的 credits 計費：mini 為動態 4–110 credits，pro 為 15–250 credits，auto 依選定層級；研究每次都計費，免費額度只涵蓋 search、extract、crawl、map 與 :online。

POST/v1/research

驗證

Authorization必填

string · header

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

Body

input必填

string

要研究的任務或問題。OpenAPI 使用 input；不接受 query 作為同義欄位。

Example: What are the latest developments in AI?

model

string

研究代理使用的模型層級；mini 適合聚焦問題，pro 適合多面向研究，auto 由服務選擇。

miniproauto

Example: mini

stream

boolean

是否以 SSE 串流研究結果；預設 false。

Example: false

output_schema

object

定義研究輸出的 JSON Schema；必須包含 properties，可選 required。

properties必填

object

輸出物件的屬性定義；每個屬性值是 JSON Schema 欄位。

required

string[]

輸出物件中必填屬性的名稱清單。

Example: ["company"]

citation_format

string

研究報告中的引用格式，預設 numbered。

numberedmlaapachicago

Example: numbered

include_domains

string[]

來源的軟性偏好；其他網域仍可能出現在報告中。

maxItems: 20

Example: ["sec.gov"]

exclude_domains

string[]

硬性封鎖來源網域與其子網域。

maxItems: 20

Example: ["reddit.com"]

output_length

string

回應大小目標；這些是目標範圍而非硬性上限，預設 standard。

shortstandardlong

Example: standard

files

array<object>

以 base64 附加 .txt、.md 或 .json 內容；最多 5 個檔案，總字數上限 80,000。

maxItems: 5

name必填

string

檔名，副檔名必須是 .txt、.md 或 .json。

Example: brief.md

data必填

string

檔案內容的 base64 編碼。

Example: <base64-encoded file contents>

type

string

data 欄位的編碼類型，預設為 base64。

base64

Example: base64

api_key

string

BazaarLink 的可選 body 驗證欄位；優先使用 Authorization: Bearer，服務會在驗證後移除此欄位。

Example: YOUR_BAZAARLINK_API_KEY

POST /v1/research

1
2
3
4
curl -X POST https://api.bazaarlink.ai/v1/research \
  -H "Authorization: Bearer $BAZAARLINK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"input":"What are the latest developments in AI?","model":"mini"}'

回應範例

研究工作已排入佇列；回傳 request_id、created_at、pending 狀態、input、model 與 response_time。

1
2
3
4
5
6
7
8
{
  "request_id": "123e4567-e89b-12d3-a456-426614174111",
  "created_at": "2025-01-15T10:30:00Z",
  "status": "pending",
  "input": "What are the latest developments in AI?",
  "model": "mini",
  "response_time": 1.23
}