Felo API PlatformFelo API Platform
Všechny endpointy Firecrawl
v0.2.0-beta
OpenAPI 3.1.0

Odešle asynchronní úlohu procházení.

Felo API Support
MIT
Server:https://openapi.felo.ai
Klientské knihovny
Shell Curl

Firecrawl

​

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

Firecrawl Operace

Odešle asynchronní úlohu procházení.

​

Odešle asynchronní procházení webu. Zadejte url a limit; volitelně dokumentované možnosti procházení a scrapování. Idempotency-Key je povinný. HTTP 202 vrací úlohu; použijte její id s odpovídajícím Felo endpointem pro dotazování, dokud úloha neskončí jako dokončená, neúspěšná nebo zrušená. Cenová pole úlohy jsou metadata autorizace a vypořádání poskytovatele, nikoli fakturační záznamy Felo.

Cenová reference

  • Účtování: reference měřeného výsledku.
  • Referenční odhad požadavku: není k dispozici.
  • Referenční jednotková cena pro zákazníka: USD 0.005.

Pouze referenční metadata, nikoli nabídka pro účet, garantovaná cena či limit utrácení. Kredity prostředků nejsou kredity Felo. Konečné účtování se řídí fakturačními záznamy Felo.

Hlavičky
  • Idempotency-Key
    Typ: string
    povinné

    Délka v UTF-8 po oříznutí musí být 1 až 191 bajtů.

Tělo
povinné
application/json
  • limit
    Typ: integer
    min:  
    1
    max:  
    1000
    povinné

    Integer numbers.

  • url
    Typ: string
    povinné

    Adresa URL HTTPS s názvem hostitele, bez přihlašovacích údajů a fragmentu. Oříznutý vstup končící na .pdf (bez rozlišování velikosti písmen) není podporován.

  • 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
    hodnoty
    • null
    • skip
    • include
    • only
Odpovědi
  • 202
    Typ: object

    Úspěch

    • completedAt
      Typ: string | null Formát: date-time
      povinné

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

    • createdAt
      Typ: string | null Formát: date-time
      povinné

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

    • endpoint
      Typ: string | null
      povinné

      Identifikátor operace poskytovatele; k dotazování používejte dokumentovanou cestu úlohy Felo.

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

      Metadata autorizace a vypořádání poskytovatele v mikro-USD; nikoli zůstatek Felo, blokace ani fakturační doklad.

      • authorizedMicrosUSD
        Typ: integer | null

        Integer numbers.

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

        Integer numbers.

    • status
      Typ: string enum
      povinné
      hodnoty
      • queued
      • running
      • completed
      • failed
      • cancelled
    • outputExpired
      Typ: boolean | null
    application/json
  • 400

    Požadavek se nepodařilo zpracovat. Zkontrolujte parametry požadavku.

  • 401

    Je vyžadován platný API klíč Felo.

  • 402

    V požadavku nelze pokračovat, protože není splněn požadavek na fakturaci.

  • 403

    Účet nemá oprávnění tuto operaci provést.

  • 429

    Byl dosažen limit požadavků nebo útraty.

  • 502

    Služba nemohla požadavek dokončit.

  • 503

    API nebo fakturační služba je dočasně nedostupná.

  • 504

    Při zpracování požadavku vypršel časový limit služby.

  • default

    Operace selhala. Při kontaktu s podporou Felo si ponechte ID požadavku z odpovědi.

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

Úspěch

Submit an asynchronous crawl job.