Felo API PlatformFelo API Platform
Wszystkie endpointy Firecrawl
v0.2.0-beta
OpenAPI 3.1.0

Prześlij asynchroniczne zadanie indeksowania.

Felo API Support
MIT
Serwer:https://openapi.felo.ai
Biblioteki klienckie
Shell Curl

Firecrawl

​

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

Firecrawl Operacje

Prześlij asynchroniczne zadanie indeksowania.

​

Przesyła asynchroniczne indeksowanie witryny. Podaj url i limit; opcjonalnie udokumentowane opcje indeksowania i skrobania. Idempotency-Key jest wymagany. HTTP 202 zwraca zadanie; użyj jego id z odpowiednim endpointem odpytywania Felo, aż zadanie zostanie ukończone, nie powiedzie się lub zostanie anulowane. Pola cenowe zadania to metadane autoryzacji i rozliczenia dostawcy, a nie zapisy rozliczeniowe Felo.

Cennik referencyjny

  • Rozliczanie: referencja naliczana od wyniku.
  • Szacunek referencyjny dla żądania: niedostępny.
  • Referencyjna cena jednostkowa klienta: USD 0.005.

Wyłącznie metadane referencyjne, a nie wycena konta, gwarantowana cena lub limit wydatków. Kredyty zasobów nie są kredytami Felo. Ostateczne obciążenia są zgodne z zapisami rozliczeniowymi Felo.

Nagłówki
  • Idempotency-Key
    Typ: string
    wymagane

    Po przycięciu długość w UTF-8 musi wynosić od 1 do 191 bajtów.

Treść
wymagane
application/json
  • limit
    Typ: integer
    min.:  
    1
    maks.:  
    1000
    wymagane

    Integer numbers.

  • url
    Typ: string
    wymagane

    Adres URL HTTPS z nazwą hosta, bez danych uwierzytelniających i fragmentu. Przycięte dane wejściowe kończące się na .pdf (bez rozróżniania wielkości liter) nie są obsługiwane.

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

    Integer numbers.

  • maxDiscoveryDepth
    Typ: integer | null
    min.:  
    0
    maks.:  
    10

    Integer numbers.

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

      Integer numbers.

    • minAge
      Typ: integer | null
      min.:  
      0
      maks.:  
      31536000000

      Integer numbers.

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

      Integer numbers.

  • sitemap
    Typ: string | null enum
    wartości
    • null
    • skip
    • include
    • only
Odpowiedzi
  • 202
    Typ: object

    Sukces

    • completedAt
      Typ: string | null Format: date-time
      wymagane

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

    • createdAt
      Typ: string | null Format: date-time
      wymagane

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

    • endpoint
      Typ: string | null
      wymagane

      Identyfikator operacji dostawcy; do odpytowania używaj udokumentowanej ścieżki zadania Felo.

    • error
      Typ: object | null
      wymagane
      • code
        Typ: string | null
      • message
        Typ: string | null
    • id
      Typ: string | null
      wymagane
    • object
      const:  
      integration_async_job
      wymagane
    • output
      wymagane
    • pricing
      Typ: object | null
      wymagane

      Metadane autoryzacji i rozliczenia dostawcy w mikro-USD; nie są to saldo Felo, rezerwacja ani dowód rozliczenia.

      • authorizedMicrosUSD
        Typ: integer | null

        Integer numbers.

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

        Integer numbers.

    • status
      Typ: string enum
      wymagane
      wartości
      • queued
      • running
      • completed
      • failed
      • cancelled
    • outputExpired
      Typ: boolean | null
    application/json
  • 400

    Nie można przetworzyć żądania. Sprawdź parametry żądania.

  • 401

    Wymagany jest prawidłowy klucz API Felo.

  • 402

    Nie można kontynuować żądania, ponieważ nie spełniono wymogu rozliczeniowego.

  • 403

    Konto nie ma uprawnień do wykonania tej operacji.

  • 429

    Osiągnięto limit żądań lub wydatków.

  • 502

    Usługa nie mogła ukończyć żądania.

  • 503

    API lub usługa rozliczeniowa jest tymczasowo niedostępna.

  • 504

    Upłynął limit czasu usługi podczas przetwarzania żądania.

  • default

    Operacja nie powiodła się. Kontaktując się z pomocą techniczną Felo, zachowaj identyfikator żądania z odpowiedzi.

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

Sukces

Submit an asynchronous crawl job.