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

Alat penyusuran laman web berasaskan graf menggunakan Tavily Crawl.

Pelayan:https://openapi.felo.ai
Pustaka Klien

Web Content

​

Web crawling, URL discovery and page extraction.

Web Content Operasi

Alat penyusuran laman web berasaskan graf menggunakan Tavily Crawl.

​

Jelajahi laman web daripada url akar dan pulangkan kandungan halaman yang ditemui. Pandu dengan instructions bahasa semula jadi serta penapis laluan dan domain regex, dan hadkan dengan max_depth, max_breadth dan limit. Memulangkan base_url dan results[] dengan url dan raw_content. Gunakan untuk liputan luas satu laman — dokumentasi, katalog, blog pesaing. Endpoint ini menjawab secara segerak, berbeza dengan post_firecrawl_crawl: endpoint itu berjalan sebagai tugas latar belakang dan sesuai untuk crawl yang terlalu besar untuk ditunggu.

Rujukan harga

  • Pemeteran: Unit respons dimeterkan.
  • Anggaran rujukan setiap permintaan: USD 0.024.
  • Asas kos unit: USD 0.008.
  • Unit sumber: tavily_credit.
  • Pengganda pelanggan rujukan: 1.0. Jangan gunakan semula pada amaun pelanggan yang telah diselesaikan.
  • Asas kos tidak menentukan harga pelanggan akhir, termasuk apabila sifar.

Metadata rujukan sahaja, bukan sebut harga akaun, harga terjamin atau had perbelanjaan. Kredit sumber bukan kredit Felo. Caj akhir mengikut rekod pengebilan Felo.

Badan
wajib
application/json
  • url
    Jenis: string
    wajib

    URL akar untuk memulakan perayauan.

  • allow_external
    Jenis: boolean

    Sertakan pautan domain luaran dalam senarai hasil akhir.

  • chunks_per_source
    Jenis: integer
    min:  
    1
    maks:  
    5

    Bilangan maksimum ketulan relevan yang dipulangkan setiap sumber.

  • exclude_domains
    Jenis: array string[]

    Corak regex untuk mengecualikan domain atau subdomain tertentu daripada perayauan.

  • exclude_paths
    Jenis: array string[]

    Corak regex untuk mengecualikan URL dengan corak laluan tertentu.

  • extract_depth
    Jenis: string enum

    Kedalaman proses pengekstrakan.

    nilai
    • basic
    • advanced
  • format
    Jenis: string enum

    Format kandungan halaman web yang diekstrak.

    nilai
    • markdown
    • text
  • include_favicon
    Jenis: boolean

    Sertakan URL favicon untuk setiap hasil.

  • include_images
    Jenis: boolean

    Sertakan imej dalam hasil perayauan.

  • include_usage
    Jenis: boolean

    Sertakan maklumat penggunaan kredit dalam respons.

  • instructions
    Jenis: string

    Arahan bahasa semula jadi untuk perayau.

  • limit
    Jenis: integer
    min:  
    1

    Jumlah pautan yang akan diproses oleh perayau sebelum berhenti.

  • max_breadth
    Jenis: integer
    min:  
    1
    maks:  
    500

    Bilangan maksimum pautan untuk diikuti setiap peringkat pokok.

  • max_depth
    Jenis: integer
    min:  
    1
    maks:  
    5

    Kedalaman maksimum perayauan.

  • select_domains
    Jenis: array string[]

    Corak regex untuk memilih perayauan ke domain atau subdomain tertentu.

  • select_paths
    Jenis: array string[]

    Corak regex untuk hanya memilih URL dengan corak laluan tertentu.

  • timeout
    Jenis: number Format: float
    min:  
    10
    maks:  
    150

    Masa maksimum dalam saat untuk menunggu operasi perayauan.

Respons
  • 200
    Jenis: object

    Hasil crawl berjaya dikembalikan.

    • base_url
      Jenis: string

      URL asas yang dirayau.

    • request_id
      Jenis: string

      Pengecam permintaan unik.

    • response_time
      Jenis: number Format: float

      Masa dalam saat yang diambil untuk menyelesaikan permintaan.

    • results
      Jenis: array object[]
      • favicon
        Jenis: string

        URL favicon halaman yang dirayau.

      • raw_content
        Jenis: string

        Kandungan mentah yang diekstrak daripada halaman.

      • url
        Jenis: string

        URL halaman yang dirayau.

    • usage
      Jenis: object
      • credits
        Jenis: integer

        Butiran penggunaan kredit untuk permintaan.

    application/json
  • 400

    Permintaan tidak dapat diproses. Semak parameter permintaan.

  • 401

    Kunci API Felo yang sah diperlukan.

  • 402

    Permintaan tidak dapat diteruskan kerana keperluan pengebilan tidak dipenuhi.

  • 403

    Akaun tidak dibenarkan melakukan operasi ini.

  • 429

    Had permintaan atau had perbelanjaan telah dicapai.

  • 502

    Perkhidmatan tidak dapat menyelesaikan permintaan.

  • 503

    API atau perkhidmatan pengebilan tidak tersedia buat sementara waktu.

  • 504

    Perkhidmatan tamat masa semasa memproses permintaan.

  • default

    Respons ralat; respons passthrough huluan mungkin menggunakan format penyedia

    application/json
Request Example for post/v1/beta/tavily/crawl
curl https://openapi.felo.ai/v1/beta/tavily/crawl \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "url": "docs.tavily.com",
  "instructions": "",
  "chunks_per_source": 3,
  "max_depth": 1,
  "max_breadth": 20,
  "limit": 50,
  "select_paths": [
    ""
  ],
  "select_domains": [
    ""
  ],
  "exclude_paths": [
    ""
  ],
  "exclude_domains": [
    ""
  ],
  "allow_external": true,
  "include_images": false,
  "extract_depth": "basic",
  "format": "markdown",
  "include_favicon": false,
  "timeout": 150,
  "include_usage": false
}'
{
  "base_url": "string",
  "results": [
    {
      "url": "string",
      "raw_content": "string",
      "favicon": "string"
    }
  ],
  "response_time": 1,
  "usage": {
    "credits": 1
  },
  "request_id": "string"
}
Graph-based website traversal tool using Tavily Crawl.