Felo API PlatformFelo API Platform
Semua endpoint Tavily
v0.2.0-beta
OpenAPI 3.1.0

Tavily Search

Felo API Support
MIT
Server:https://openapi.felo.ai
Pustaka Klien
Shell Curl

Tavily Search

​

Cari di web dan kembalikan hasil berperingkat dengan judul, URL, dan cuplikan konten. query wajib diisi. Gunakan max_results untuk mengontrol jumlah hasil dan search_depth untuk memilih mode pencarian. answer, images, dan konten mentah tambahan hanya dikembalikan jika diminta. Setel include_usage untuk menerima informasi penggunaan sumber daya; usage.credits bukan biaya Felo.

Referensi harga

  • Metering: Unit respons terukur.
  • Estimasi referensi per permintaan: USD 0.016.
  • Dasar biaya unit: USD 0.008.
  • Unit sumber daya: tavily_credit.
  • Pengali pelanggan referensi: 1.0. Jangan terapkan lagi pada jumlah pelanggan yang telah diselesaikan.
  • Dasar biaya tidak menentukan harga pelanggan akhir, termasuk saat bernilai nol.

Hanya metadata referensi, bukan penawaran akun, harga yang dijamin, atau batas pengeluaran. Kredit sumber daya bukanlah kredit Felo. Biaya akhir mengikuti catatan tagihan Felo.

Isi
wajib
application/json
  • query
    Tipe: string
    wajib

    Kueri pencarian yang akan dijalankan dengan Tavily.

  • auto_parameters
    Tipe: boolean

    Konfigurasikan parameter pencarian secara otomatis berdasarkan konten kueri.

  • chunks_per_source
    Tipe: integer
    min:  
    1
    maks:  
    3

    Jumlah maksimum potongan relevan yang dikembalikan per sumber.

  • country
    Tipe: string enum

    Tingkatkan hasil pencarian dari negara tertentu. Hanya tersedia saat topic bernilai general.

    nilai
    • afghanistan
    • albania
    • algeria
    • andorra
    • angola
  • end_date
    Tipe: string Format: date

    Kembalikan hasil sebelum tanggal akhir yang ditentukan.

  • exclude_domains
    Tipe: array string[] …150

    Daftar domain yang secara khusus dikecualikan dari hasil pencarian.

  • include_answer

    Sertakan jawaban yang dihasilkan LLM. true menggunakan mode jawaban default; basic atau advanced memilih mode pembuatan jawaban.

    • Tipe: boolean

      Sertakan jawaban yang dihasilkan LLM. true menggunakan mode jawaban default; basic atau advanced memilih mode pembuatan jawaban.

  • include_domains
    Tipe: array string[] …300

    Daftar domain yang secara khusus disertakan dalam hasil pencarian.

  • include_favicon
    Tipe: boolean

    Sertakan URL favicon untuk setiap hasil.

  • include_image_descriptions
    Tipe: boolean

    Tambahkan teks deskriptif untuk setiap gambar saat include_images bernilai true.

  • include_images
    Tipe: boolean

    Lakukan pencarian gambar dan sertakan hasilnya.

  • include_raw_content

    Sertakan konten yang dibersihkan dan diurai untuk setiap hasil pencarian. true atau markdown mengembalikan markdown; text mengembalikan teks biasa dan dapat meningkatkan latensi.

    • Tipe: boolean

      Sertakan konten yang dibersihkan dan diurai untuk setiap hasil pencarian. true atau markdown mengembalikan markdown; text mengembalikan teks biasa dan dapat meningkatkan latensi.

  • include_usage
    Tipe: boolean

    Sertakan informasi penggunaan sumber daya dalam respons. Ini bukan informasi penagihan Felo.

  • max_results
    Tipe: integer
    min:  
    0
    maks:  
    20

    Jumlah maksimum hasil pencarian yang dikembalikan.

  • Tipe: boolean

    Filter konten dewasa atau tidak aman dari hasil pencarian. Hanya Enterprise; tidak didukung saat search_depth bernilai fast atau ultra-fast.

  • search_depth
    Tipe: string enum

    Mengontrol tradeoff latensi vs relevansi. advanced memberikan relevansi tertinggi dengan latensi dan biaya lebih tinggi; basic seimbang; fast dan ultra-fast mengoptimalkan latensi lebih rendah.

    nilai
    • advanced
    • basic
    • fast
    • ultra-fast
  • start_date
    Tipe: string Format: date

    Kembalikan hasil setelah tanggal mulai yang ditentukan.

  • time_range
    Tipe: string enum

    Rentang waktu untuk memfilter hasil berdasarkan tanggal terbit.

    nilai
    • day
    • week
    • month
    • year
    • d
    • w
    • m
    • y
  • topic
    Tipe: string enum

    Kategori pencarian.

    nilai
    • general
    • news
    • finance
Respons
  • 200
    Tipe: object

    Hasil pencarian berhasil dikembalikan.

    • answer
      Tipe: string | null

      Jawaban singkat yang dihasilkan LLM. Ditampilkan sebagai null saat include_answer bernilai false atau tidak ada jawaban yang dihasilkan.

    • images
      Tipe: array object[]
      • description
        Tipe: string

        Deskripsi gambar.

      • url
        Tipe: string

        URL gambar.

    • query
      Tipe: string

      Kueri pencarian yang dijalankan.

    • request_id
      Tipe: string

      Pengenal permintaan unik.

    • response_time
      Tipe: number Format: float

      Waktu dalam detik yang dibutuhkan untuk menyelesaikan permintaan.

    • results
      Tipe: array object[]
      • content
        Tipe: string

        Cuplikan konten dari hasil pencarian.

      • favicon
        Tipe: string | null

        URL favicon hasil pencarian.

      • raw_content
        Tipe: string | null

        Konten sumber yang dibersihkan dan diurai. Null kecuali include_raw_content diminta atau tidak ada konten mentah yang tersedia.

      • score
        Tipe: number Format: float

        Skor relevansi hasil pencarian.

      • title
        Tipe: string

        Judul hasil pencarian.

      • url
        Tipe: string

        URL hasil pencarian.

    • usage
      Tipe: object
      • credits
        Tipe: integer

        Unit sumber daya yang dikonsumsi permintaan ini, bukan USD atau kredit Felo.

    application/json
  • 400

    Permintaan tidak dapat diproses. Periksa parameter permintaan.

  • 401

    Kunci API Felo yang valid diperlukan.

  • 402

    Permintaan tidak dapat dilanjutkan karena persyaratan penagihan belum terpenuhi.

  • 403

    Akun tidak diizinkan melakukan operasi ini.

  • 429

    Batas permintaan atau batas pengeluaran telah tercapai.

  • 502

    Layanan tidak dapat menyelesaikan permintaan.

  • 503

    API atau layanan penagihan untuk sementara tidak tersedia.

  • 504

    Layanan kehabisan waktu saat memproses permintaan.

  • default

    Respons error; respons passthrough upstream dapat menggunakan format penyedia

    application/json
Request Example for post/v1/beta/tavily/search
curl --request POST https://openapi.felo.ai/v1/beta/tavily/search \
  --header "Authorization: Bearer ${FELO_API_KEY:?Set FELO_API_KEY}" \
  --header 'Content-Type: application/json' \
  --data '{"query": "Python official documentation", "search_depth": "basic", "max_results": 2, "include_usage": true}'

{
  "query": "Python official documentation",
  "answer": null,
  "images": [],
  "results": [
    {
      "title": "Python Documentation",
      "url": "https://docs.python.org/3/",
      "content": "Documentation for the Python programming language.",
      "score": 0.98,
      "raw_content": null
    }
  ],
  "response_time": 1.2,
  "usage": {
    "credits": 1
  },
  "request_id": "example-search-request"
}

Hasil pencarian berhasil dikembalikan.

Tavily Search