Felo API PlatformFelo API Platform
Alle Endpoints von Firecrawl
v0.2.0-beta
OpenAPI 3.1.0

Einen asynchronen Crawl-Job einreichen.

Felo API Support
MIT
Server:https://openapi.felo.ai
Client-Bibliotheken
Shell Curl

Firecrawl

​

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

Firecrawl Operationen

Einen asynchronen Crawl-Job einreichen.

​

Reicht einen asynchronen Website-Crawl ein. Geben Sie url und limit an; optional die dokumentierten Crawl- und Scrape-Optionen. Idempotency-Key ist erforderlich. HTTP 202 liefert einen Job; verwenden Sie dessen id mit dem entsprechenden Felo-Polling-Endpunkt, bis er completed, failed oder cancelled lautet. Preisangaben im Job sind Autorisierungs- und Abrechnungsmetadaten des Anbieters, keine Felo-Abrechnungsbelege.

Preisreferenz

  • Abrechnung: Referenz pro abgerechnetem Ergebnis.
  • Referenzschätzung pro Anfrage nicht verfügbar.
  • Referenzpreis pro Kundeneinheit: USD 0.005.

Nur Referenzmetadaten, kein Kontenangebot, kein garantierter Preis und keine Ausgabenobergrenze. Ressourcen-Credits sind keine Felo-Credits. Endgültige Abrechnungen richten sich nach den Felo-Abrechnungsbelegen.

Header
  • Idempotency-Key
    Typ: string
    erforderlich

    Die getrimmte UTF-8-Länge muss 1 bis 191 Byte betragen.

Body
erforderlich
application/json
  • limit
    Typ: integer
    min.:  
    1
    max.:  
    1000
    erforderlich

    Integer numbers.

  • url
    Typ: string
    erforderlich

    HTTPS-URL mit Hostname, ohne Zugangsdaten oder Fragment. Getrimmte Eingaben, die auf .pdf enden (Groß-/Kleinschreibung wird nicht unterschieden), werden nicht unterstützt.

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

    Integer numbers.

  • maxDiscoveryDepth
    Typ: integer | null
    min.:  
    0
    max.:  
    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
      max.:  
      31536000000

      Integer numbers.

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

      Integer numbers.

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

      Integer numbers.

  • sitemap
    Typ: string | null enum
    Werte
    • null
    • skip
    • include
    • only
Antworten
  • 202
    Typ: object

    Erfolg

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

      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
      erforderlich

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

    • endpoint
      Typ: string | null
      erforderlich

      Anbieter-Operations-ID; verwenden Sie den dokumentierten Felo-Job-Pfad für das Polling.

    • error
      Typ: object | null
      erforderlich
      • code
        Typ: string | null
      • message
        Typ: string | null
    • id
      Typ: string | null
      erforderlich
    • object
      Konstante:  
      integration_async_job
      erforderlich
    • output
      erforderlich
    • pricing
      Typ: object | null
      erforderlich

      Autorisierungs- und Abrechnungsmetadaten des Anbieters in Mikro-USD; kein Felo-Guthaben, keine Reservierung und kein Abrechnungsbeleg.

      • authorizedMicrosUSD
        Typ: integer | null

        Integer numbers.

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

        Integer numbers.

    • status
      Typ: string enum
      erforderlich
      Werte
      • queued
      • running
      • completed
      • failed
      • cancelled
    • outputExpired
      Typ: boolean | null
    application/json
  • 400

    Die Anfrage konnte nicht verarbeitet werden. Prüfen Sie die Anfrageparameter.

  • 401

    Ein gültiger Felo-API-Schlüssel ist erforderlich.

  • 402

    Die Anfrage kann nicht fortgesetzt werden, da eine Abrechnungsvoraussetzung nicht erfüllt ist.

  • 403

    Das Konto ist für diesen Vorgang nicht berechtigt.

  • 429

    Ein Anfrage- oder Ausgabenlimit wurde erreicht.

  • 502

    Der Dienst konnte die Anfrage nicht abschließen.

  • 503

    Die API oder der Abrechnungsdienst ist vorübergehend nicht verfügbar.

  • 504

    Beim Verarbeiten der Anfrage ist eine Zeitüberschreitung aufgetreten.

  • default

    Der Vorgang ist fehlgeschlagen. Bewahren Sie die Anfrage-ID der Antwort auf, wenn Sie den Felo-Support kontaktieren.

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

Erfolg

Submit an asynchronous crawl job.