Dokumentasi Referensi API Referensi SDK Penggunaan Agentik Skill AI

Pencarian Web

Pencarian web

`POST /v1/search` yang kompatibel dengan Tavily mengembalikan hasil berperingkat tanpa memanggil model bahasa. Autentikasi dengan `Authorization: Bearer <BazaarLink key>` atau `api_key` dalam JSON body. Gunakan base URL `https://api.bazaarlink.ai/v1` atau URL lama yang sepenuhnya didukung `https://bazaarlink.ai/api/v1`. Semua field OpenAPI beku divalidasi; field yang tidak dikenal diabaikan. Opsi kedalaman, tanggal, bahasa, domain, gambar, jawaban, dan raw content mengikuti kontrak di bawah. Alokasi gratis memerlukan email terverifikasi dan direset setiap hari pukul 00:00 UTC; akun tanpa saldo dan akun yang didanai memiliki alokasi berbeda. Nilai N/M saat ini berasal dari database melalui `getPublicFreeSearchAllowance()`; lihat pricing page untuk alokasi harian terbaru. Jika alokasi gratis habis dan tidak ada saldo, responsnya 432. Harga pelanggan adalah jumlah credit dikalikan harga per credit yang dikonfigurasi admin. Jangan hard-code harga dolar; lihat pricing page dan baca `usage.cost` pada setiap respons. Python memakai `TavilyClient(api_key=..., api_base_url='https://api.bazaarlink.ai/v1')`; JS memakai `tavily({ apiKey, apiBaseURL })`; LangChain memakai `TavilySearch(api_base_url=...)`.

POST/v1/search

Otorisasi

Authorizationwajib

string · header

API key sebagai bearer token di header Authorization.

Body

querywajib

string

Kueri pencarian yang akan dijalankan.

required; non-empty search query

Example: who is Leo Messi?

search_depth

string

Mengontrol latensi, relevansi, dan pembuatan konten hasil. Default: `basic`; `basic`, `fast`, dan `ultra-fast` masing-masing berbiaya 1 credit, sedangkan `advanced` 2 credits.

default: basic

advancedbasicfastultra-fast

chunks_per_source

integer

Jumlah maksimum potongan konten relevan per sumber. Default: 3; rentang yang diizinkan 1–3. Tersedia untuk `advanced`, `basic`, dan `fast`.

default: 3; 1..3

max_results

integer

Jumlah maksimum hasil pencarian yang dikembalikan. Default: 10; rentang 0–20.

default: 10; 0..20

Example: 1

topic

string

Topik pencarian. Default: `general`; gunakan `news` untuk berita terkini dan `finance` untuk konten keuangan.

default: general

generalnewsfinance

time_range

string

Memfilter berdasarkan tanggal publikasi atau pembaruan. Default: tidak diatur. Nilai yang diizinkan: `day`, `week`, `month`, `year`, `d`, `w`, `m`, `y`.

default: null

dayweekmonthyeardwmy

start_date

string

Mengembalikan hasil yang dipublikasikan atau diperbarui setelah tanggal ini. Format: YYYY-MM-DD.

default: null; format YYYY-MM-DD

Example: 2025-02-09

end_date

string

Mengembalikan hasil yang dipublikasikan atau diperbarui sebelum tanggal ini. Format: YYYY-MM-DD.

default: null; format YYYY-MM-DD

Example: 2025-12-29

include_published_date

boolean

Menyertakan perkiraan tanggal publikasi atau pembaruan pada setiap hasil. Otomatis aktif untuk topik `news`. Default: `false`.

default: false

filter_by_published_date

boolean

Menghapus hasil di luar jendela `time_range`, `start_date`, atau `end_date`, termasuk hasil tanpa tanggal yang terdeteksi. Default: `false`; `true` juga mengaktifkan `include_published_date`.

default: false

include_answer

boolean | string

Menyertakan jawaban yang dibuat LLM. Default: `false`; menerima boolean atau `basic`/`advanced`.

default: false

basicadvanced

include_raw_content

boolean | string

Menyertakan konten HTML yang dibersihkan untuk setiap hasil. Default: `false`; menerima boolean atau `markdown`/`text`.

default: false

markdowntext

include_images

boolean

Menyertakan gambar terkait kueri di tingkat teratas dan gambar sumber di setiap hasil. Default: `false`.

default: false

include_image_descriptions

boolean

Saat `include_images` bernilai `true`, menambahkan deskripsi pada setiap gambar. Default: `false`.

default: false

include_favicon

boolean

Apakah menyertakan URL favicon untuk setiap hasil. Default: `false`.

default: false

include_domains

string[]

Membatasi hasil ke domain yang dicantumkan; maksimum 300 domain. Default: array kosong.

default: []; maximum 300 items

exclude_domains

string[]

Mengecualikan hasil dari domain yang dicantumkan; maksimum 150 domain. Default: array kosong.

default: []; maximum 150 items

include_domains_mode

string

Mengontrol penerapan `include_domains`. `restrict` membatasi hasil ke domain tersebut; `prefer` memprioritaskannya tetapi dapat mengembalikan domain lain. Memerlukan `include_domains`, jika tidak 400. Default: tidak diatur.

default: null; requires include_domains

restrictprefer

country

string

Meningkatkan hasil dari negara yang dipilih. Hanya tersedia saat `topic` adalah `general`. Default: tidak diatur.

default: null; only when topic is general

afghanistanalbaniaalgeriaandorraangolaargentinaarmeniaaustraliaaustriaazerbaijanbahamasbahrainbangladeshbarbadosbelarusbelgiumbelizebeninbhutanboliviabosnia and herzegovinabotswanabrazilbruneibulgariaburkina fasoburundicambodiacamerooncanadacape verdecentral african republicchadchilechinacolombiacomoroscongocosta ricacroatiacubacyprusczech republicdenmarkdjiboutidominican republicecuadoregyptel salvadorequatorial guineaeritreaestoniaethiopiafijifinlandfrancegabongambiageorgiagermanyghanagreeceguatemalaguineahaitihondurashungaryicelandindiaindonesiairaniraqirelandisraelitalyjamaicajapanjordankazakhstankenyakuwaitkyrgyzstanlatvialebanonlesotholiberialibyaliechtensteinlithuanialuxembourgmadagascarmalawimalaysiamaldivesmalimaltamauritaniamauritiusmexicomoldovamonacomongoliamontenegromoroccomozambiquemyanmarnamibianepalnetherlandsnew zealandnicaraguanigernigerianorth koreanorth macedonianorwayomanpakistanpanamapapua new guineaparaguayperuphilippinespolandportugalqatarromaniarussiarwandasaudi arabiasenegalserbiasingaporeslovakiasloveniasomaliasouth africasouth koreasouth sudanspainsri lankasudanswedenswitzerlandsyriataiwantajikistantanzaniathailandtogotrinidad and tobagotunisiaturkeyturkmenistanugandaukraineunited arab emiratesunited kingdomunited statesuruguayuzbekistanvenezuelavietnamyemenzambiazimbabwe

language

string

Meningkatkan hasil dalam bahasa yang dipilih. Menerima kode ISO 639-1 atau nama bahasa Inggris. Default: tidak diatur.

default: null

Example: en

filter_by_language

boolean

Menghapus hasil yang tidak cocok dengan `language` secara ketat. Memerlukan `language`, jika tidak 400. Default: `false`.

default: false; requires language

auto_parameters

boolean

Memilih parameter pencarian secara otomatis dari maksud kueri. Nilai eksplisit lebih diutamakan; `include_answer`, `include_raw_content`, dan `max_results` harus diatur manual. Menambah biaya 2 credits per permintaan. Default: `false`.

default: false; costs 2 credits

exact_match

boolean

Mengembalikan hanya hasil yang berisi frasa dalam tanda kutip dari kueri, melewati sinonim dan variasi semantik. Default: `false`.

default: false

include_usage

boolean

Apakah menyertakan penggunaan credit dalam respons. Default: `false`.

default: false

safe_search

boolean

Memfilter konten dewasa atau tidak aman. Default: `false`; tidak didukung untuk `fast` dan `ultra-fast`.

default: false; unsupported for fast and ultra-fast

api_key

string

Field autentikasi JSON body opsional. Jika tidak ada header Bearer, berikan BazaarLink API key di sini; field ini dihapus sebelum validasi dan penerusan.

days

integer

Field kompatibilitas SDK `days`. Diterima untuk kompatibilitas; sesuai rencana dapat diteruskan atau diabaikan dan bukan bagian dari skema OpenAPI beku.

max_hours

integer

Field kompatibilitas SDK `max_hours`. Diterima untuk kompatibilitas; sesuai rencana dapat diteruskan atau diabaikan dan bukan bagian dari skema OpenAPI beku.

fetch_timeout

number

Field kompatibilitas SDK `fetch_timeout`. Diterima untuk kompatibilitas; sesuai rencana dapat diteruskan atau diabaikan dan bukan bagian dari skema OpenAPI beku.

cache_fallback

boolean

Field kompatibilitas SDK `cache_fallback`. Diterima untuk kompatibilitas; sesuai rencana dapat diteruskan atau diabaikan dan bukan bagian dari skema OpenAPI beku.

timeout

number

Field `timeout` yang kompatibel dengan SDK. Diterima untuk kompatibilitas; pencarian menggunakan timeout sisi layanan dan field yang tidak dikenal atau tidak didukung diabaikan.

POST /v1/search

1
2
3
4
5
6
7
8
9
10
curl https://api.bazaarlink.ai/v1/search \
  -H "Authorization: Bearer $BAZAARLINK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "latest news on open-source language models",
    "search_depth": "basic",
    "max_results": 5,
    "topic": "news",
    "time_range": "week"
  }'

Contoh respons

Respons sukses berisi `query`, `answer` opsional, `images` tingkat teratas, `results` (masing-masing dengan `title`, `url`, `content`, `score`, serta `raw_content`, `published_date`, `favicon`, `images`, `id` opsional), `auto_parameters` opsional, `response_time`, `usage` (`credits` plus `cost` tambahan kami), dan `request_id`. `usage.cost` adalah harga USD yang ditagihkan kepada pelanggan, bukan COGS; `request_id` dibuat oleh BazaarLink.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
{
  "query": "Who is Leo Messi?",
  "answer": "Lionel Messi is an Argentine footballer.",
  "images": [
    {
      "url": "https://example.com/messi.jpg",
      "description": "Lionel Messi"
    }
  ],
  "results": [
    {
      "title": "Lionel Messi Facts | Britannica",
      "url": "https://www.britannica.com/facts/Lionel-Messi",
      "content": "Lionel Messi is an Argentine footballer.",
      "score": 0.81025416,
      "raw_content": null,
      "published_date": "Tue, 11 Mar 2025 17:00:00 GMT",
      "favicon": "https://britannica.com/favicon.png",
      "images": [
        {
          "url": "https://example.com/messi.jpg",
          "description": "Lionel Messi"
        }
      ],
      "id": "a3f9c2-04"
    }
  ],
  "auto_parameters": {
    "topic": "general",
    "search_depth": "basic"
  },
  "response_time": 1.67,
  "usage": {
    "credits": 1,
    "cost": "<customer_price_usd>"
  },
  "request_id": "123e4567-e89b-12d3-a456-426614174111"
}