Dokumentasi Referensi API Referensi SDK Penggunaan Agentik Skill AI

Akun

Buat tugas riset Tavily

Mengantrikan tugas riset asinkron. Field wajib menurut OpenAPI adalah input (bukan query); model dapat berupa mini, pro, atau auto, dan stream=true mengembalikan aliran SSE. Gunakan autentikasi Bearer sebagai pilihan utama; api_key opsional di JSON body juga didukung. Riset ditagih sesuai pemakaian berdasarkan credits yang benar-benar digunakan: mini dinamis dalam rentang 4–110 credits dan pro 15–250 credits; auto mengikuti tier yang dipilih. Tunjangan gratis tidak berlaku untuk research; tunjangan ini mencakup search, extract, crawl, map, dan :online.

POST/v1/research

Otorisasi

Authorizationwajib

string · header

API key sebagai bearer token di header Authorization.

Body

inputwajib

string

Tugas atau pertanyaan yang diteliti. Field OpenAPI adalah input; query bukan alias.

Example: What are the latest developments in AI?

model

string

Tier agen riset: mini untuk pertanyaan terarah, pro untuk riset multi-sudut, atau auto untuk pilihan layanan.

miniproauto

Example: mini

stream

boolean

Apakah hasil riset dialirkan sebagai SSE; default false.

Example: false

output_schema

object

JSON Schema untuk keluaran riset; wajib berisi properties dan boleh berisi required.

propertieswajib

object

Definisi properti objek keluaran; setiap nilai adalah field JSON Schema.

required

string[]

Nama properti yang wajib ada di objek keluaran.

Example: ["company"]

citation_format

string

Format sitasi laporan riset; default-nya numbered.

numberedmlaapachicago

Example: numbered

include_domains

string[]

Preferensi lunak sumber; domain lain tetap dapat muncul dalam laporan.

maxItems: 20

Example: ["sec.gov"]

exclude_domains

string[]

Daftar blokir keras domain sumber dan subdomain-nya.

maxItems: 20

Example: ["reddit.com"]

output_length

string

Target ukuran respons; bukan batas keras, default-nya standard.

shortstandardlong

Example: standard

files

array<object>

Sumber .txt, .md, atau .json berformat Base64; maksimal 5 file dan 80.000 kata gabungan.

maxItems: 5

namewajib

string

Nama file dengan ekstensi .txt, .md, atau .json.

Example: brief.md

datawajib

string

Isi file yang dikodekan dengan Base64.

Example: <base64-encoded file contents>

type

string

Pengodean data; default-nya base64.

base64

Example: base64

api_key

string

Kredensial body BazaarLink opsional; utamakan Authorization: Bearer dan field ini dihapus setelah autentikasi.

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

Contoh respons

Tugas riset masuk antrean dan mengembalikan request_id, created_at, status pending, input, model, dan 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
}