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

Hantar tugas crawl tak segerak.

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

Firecrawl

​

Search, scrape, map, file parsing and asynchronous crawling.

Hantar tugas crawl tak segerak.

​

Hantar crawl laman web tak segerak. Sediakan url dan limit; pilihan pilihan crawl dan scrape yang didokumenkan. Idempotency-Key diperlukan. HTTP 202 memulangkan tugas; gunakan id-nya dengan endpoint tinjauan Felo yang berkaitan sehingga completed, failed atau cancelled. Medan harga tugas ialah metadata kebenaran dan penyelesaian penyedia, bukan rekod pengebilan Felo.

Rujukan harga

  • Pemeteran: Rujukan hasil dimeterkan.
  • Anggaran rujukan setiap permintaan tidak tersedia.
  • Harga rujukan unit pelanggan: USD 0.005.

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

Pengepala
  • Idempotency-Key
    Jenis: string
    wajib

    Panjang UTF-8 selepas dipangkas mesti 1 hingga 191 bait.

Badan
wajib
application/json
  • limit
    Jenis: integer
    min:  
    1
    maks:  
    1000
    wajib

    Integer numbers.

  • url
    Jenis: string
    wajib

    URL HTTPS dengan nama hos, tanpa kelayakan atau fragmen. Input yang dipangkas dan berakhir dengan .pdf (tidak sensitif huruf besar/kecil) tidak disokong.

  • Jenis: boolean | null
  • allowSubdomains
    Jenis: boolean | null
  • crawlEntireDomain
    Jenis: boolean | null
  • delay
    Jenis: number | null
    min:  
    0
    maks:  
    30
  • excludePaths
    Jenis: array string[] | null …20
  • ignoreQueryParameters
    Jenis: boolean | null
  • includePaths
    Jenis: array string[] | null …20
  • maxConcurrency
    Jenis: integer | null
    min:  
    1
    maks:  
    20

    Integer numbers.

  • maxDiscoveryDepth
    Jenis: integer | null
    min:  
    0
    maks:  
    10

    Integer numbers.

  • scrapeOptions
    Jenis: object | null
    • excludeTags
      Jenis: array string[] | null …50
    • includeTags
      Jenis: array string[] | null …50
    • maxAge
      Jenis: integer | null
      min:  
      0
      maks:  
      31536000000

      Integer numbers.

    • minAge
      Jenis: integer | null
      min:  
      0
      maks:  
      31536000000

      Integer numbers.

    • onlyMainContent
      Jenis: boolean | null
    • timeout
      Jenis: integer | null
      min:  
      1000
      maks:  
      300000

      Integer numbers.

  • sitemap
    Jenis: string | null enum
    nilai
    • null
    • skip
    • include
    • only
Respons
  • 202
    Jenis: object

    Berjaya

    • completedAt
      Jenis: string | null Format: date-time
      wajib

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • createdAt
      Jenis: string | null Format: date-time
      wajib

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • endpoint
      Jenis: string | null
      wajib

      Pengecam operasi penyedia; gunakan laluan tugas Felo yang didokumenkan untuk tinjauan.

    • error
      Jenis: object | null
      wajib
      • code
        Jenis: string | null
      • message
        Jenis: string | null
    • id
      Jenis: string | null
      wajib
    • object
      const:  
      integration_async_job
      wajib
    • output
      wajib
    • pricing
      Jenis: object | null
      wajib

      Metadata kebenaran dan penyelesaian penyedia dalam micro-USD; bukan baki Felo, tahanan atau resit pengebilan.

      • authorizedMicrosUSD
        Jenis: integer | null

        Integer numbers.

      • billingMode
        Jenis: string | null
      • currency
        Jenis: string | null
      • finalMicrosUSD
        Jenis: integer | null

        Integer numbers.

    • status
      Jenis: string enum
      wajib
      nilai
      • queued
      • running
      • completed
      • failed
      • cancelled
    • outputExpired
      Jenis: boolean | null
    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

    Operasi gagal. Simpan ID permintaan respons apabila menghubungi sokongan Felo.

Request Example for post/v1/beta/firecrawl/crawl
curl https://openapi.felo.ai/v1/beta/firecrawl/crawl \
  --request POST \
  --header 'Idempotency-Key: ' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "url": "https://example.com",
  "limit": 1
}'
{
  "completedAt": null,
  "createdAt": null,
  "endpoint": null,
  "error": {
    "code": null,
    "message": null
  },
  "id": null,
  "object": "integration_async_job",
  "output": null,
  "outputExpired": null,
  "pricing": {
    "authorizedMicrosUSD": null,
    "billingMode": null,
    "currency": null,
    "finalMicrosUSD": null
  },
  "status": "queued"
}
Submit an asynchronous crawl job.