Felo API PlatformFelo API Platform
Alle endpoints van Firecrawl
v0.2.0-beta
OpenAPI 3.1.0

Een asynchrone crawl-job indienen.

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

Firecrawl

​

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

Firecrawl Operaties

Een asynchrone crawl-job indienen.

​

Dient een asynchrone websitecrawl in. Geef url en limit op; optioneel de gedocumenteerde crawl- en scrape-opties. Idempotency-Key is vereist. HTTP 202 retourneert een job; gebruik het id ervan met het bijbehorende Felo-pollingendpoint tot deze completed, failed of cancelled is. Prijsvelden van de job zijn autorisatie- en afrekeningsmetadata van de provider, geen Felo-factureringsgegevens.

Prijsreferentie

  • Metering: Referentie per gemeten resultaat.
  • Referentieschatting per verzoek niet beschikbaar.
  • Referentieprijs per klanteenheid: USD 0.005.

Alleen referentiemetadata, geen accountofferte, geen gegarandeerde prijs en geen bestedingslimiet. Resourcecredits zijn geen Felo-tegoed. De uiteindelijke kosten volgen de factureringsgegevens van Felo.

Headers
  • Idempotency-Key
    Type: string
    verplicht

    De getrimde UTF-8-lengte moet 1 tot en met 191 bytes zijn.

Body
verplicht
application/json
  • limit
    Type: integer
    min.:  
    1
    max.:  
    1000
    verplicht

    Integer numbers.

  • url
    Type: string
    verplicht

    HTTPS-URL met een hostnaam, zonder inloggegevens of fragment. Getrimde invoer die eindigt op .pdf (hoofdletterongevoelig) wordt niet ondersteund.

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

    Integer numbers.

  • maxDiscoveryDepth
    Type: integer | null
    min.:  
    0
    max.:  
    10

    Integer numbers.

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

      Integer numbers.

    • minAge
      Type: integer | null
      min.:  
      0
      max.:  
      31536000000

      Integer numbers.

    • onlyMainContent
      Type: boolean | null
    • timeout
      Type: integer | null
      min.:  
      1000
      max.:  
      300000

      Integer numbers.

  • sitemap
    Type: string | null enum
    waarden
    • null
    • skip
    • include
    • only
Responsen
  • 202
    Type: object

    Geslaagd

    • completedAt
      Type: string | null Formaat: date-time
      verplicht

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

    • createdAt
      Type: string | null Formaat: date-time
      verplicht

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

    • endpoint
      Type: string | null
      verplicht

      Provider-operatie-identificatie; gebruik het gedocumenteerde Felo-jobpad voor polling.

    • error
      Type: object | null
      verplicht
      • code
        Type: string | null
      • message
        Type: string | null
    • id
      Type: string | null
      verplicht
    • object
      constante:  
      integration_async_job
      verplicht
    • output
      verplicht
    • pricing
      Type: object | null
      verplicht

      Autorisatie- en afwikkelingsmetadata van de provider in micro-USD; geen Felo-saldo, reservering of factureringsbewijs.

      • authorizedMicrosUSD
        Type: integer | null

        Integer numbers.

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

        Integer numbers.

    • status
      Type: string enum
      verplicht
      waarden
      • queued
      • running
      • completed
      • failed
      • cancelled
    • outputExpired
      Type: boolean | null
    application/json
  • 400

    Het verzoek kon niet worden verwerkt. Controleer de verzoekparameters.

  • 401

    Een geldige Felo-API-sleutel is vereist.

  • 402

    Het verzoek kan niet doorgaan omdat niet aan een factureringsvoorwaarde is voldaan.

  • 403

    Het account mag deze bewerking niet uitvoeren.

  • 429

    Een verzoek- of bestedingslimiet is bereikt.

  • 502

    De dienst kon het verzoek niet voltooien.

  • 503

    De API of factureringsdienst is tijdelijk niet beschikbaar.

  • 504

    Er is een time-out opgetreden bij het verwerken van het verzoek.

  • default

    De bewerking is mislukt. Bewaar de verzoek-ID uit de respons wanneer je contact opneemt met Felo-ondersteuning.

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

Geslaagd

Submit an asynchronous crawl job.