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

Op grafen gebaseerd hulpmiddel voor het doorlopen van websites met Tavily Crawl.

Server:https://openapi.felo.ai
Clientbibliotheken

Web Content

​

Web crawling, URL discovery and page extraction.

Web Content Operaties

Op grafen gebaseerd hulpmiddel voor het doorlopen van websites met Tavily Crawl.

​

Doorzoekt een site vanaf een root-url en retourneert de inhoud van de gevonden pagina's. Stuur het bij met natuurlijke-taal-instructions plus regex-filters voor paden en domeinen, en begrens het met max_depth, max_breadth en limit. Retourneert base_url en results[] met url en raw_content. Gebruik het voor brede dekking van één site: documentatie, een catalogus, de blog van een concurrent. Het antwoordt synchroon, wat post_firecrawl_crawl niet doet: dat draait als achtergrondtaak en is geschikt voor crawls die te groot zijn om op te wachten.

Prijsreferentie

  • Metering: Gemeten responseenheden.
  • Referentieschatting per verzoek: USD 0.024.
  • Kostenbasis per eenheid: USD 0.008.
  • Resource-eenheid: tavily_credit.
  • Referentiemultiplier voor klanten: 1.0. Niet opnieuw toepassen op een al afgerekend klantbedrag.
  • Kostenbases bepalen niet de uiteindelijke klantprijs, ook niet wanneer die nul is.

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

Body
verplicht
application/json
  • url
    Type: string
    verplicht

    De root-URL waar de crawl begint.

  • allow_external
    Type: boolean

    Externe domeinlinks opnemen in de definitieve resultatenlijst.

  • chunks_per_source
    Type: integer
    min.:  
    1
    max.:  
    5

    Maximaal aantal relevante chunks dat per bron wordt geretourneerd.

  • exclude_domains
    Type: array string[]

    Regex-patronen om specifieke domeinen of subdomeinen van het crawlen uit te sluiten.

  • exclude_paths
    Type: array string[]

    Regex-patronen om URL's met specifieke padpatronen uit te sluiten.

  • extract_depth
    Type: string enum

    Diepte van het extractieproces.

    waarden
    • basic
    • advanced
  • format
    Type: string enum

    Formaat van de geëxtraheerde webpagina-inhoud.

    waarden
    • markdown
    • text
  • include_favicon
    Type: boolean

    De favicon-URL voor elk resultaat opnemen.

  • include_images
    Type: boolean

    Afbeeldingen opnemen in de crawlresultaten.

  • include_usage
    Type: boolean

    Informatie over creditgebruik opnemen in de respons.

  • instructions
    Type: string

    Instructies in natuurlijke taal voor de crawler.

  • limit
    Type: integer
    min.:  
    1

    Totaal aantal links dat de crawler verwerkt voordat hij stopt.

  • max_breadth
    Type: integer
    min.:  
    1
    max.:  
    500

    Maximaal aantal links dat per niveau van de boom wordt gevolgd.

  • max_depth
    Type: integer
    min.:  
    1
    max.:  
    5

    Maximale diepte van de crawl.

  • select_domains
    Type: array string[]

    Regex-patronen om het crawlen tot specifieke domeinen of subdomeinen te beperken.

  • select_paths
    Type: array string[]

    Regex-patronen om alleen URL's met specifieke padpatronen te selecteren.

  • timeout
    Type: number Formaat: float
    min.:  
    10
    max.:  
    150

    Maximale wachttijd in seconden voor de crawl-bewerking.

Responsen
  • 200
    Type: object

    Crawleresultaten succesvol geretourneerd.

    • base_url
      Type: string

      De basis-URL die is gecrawld.

    • request_id
      Type: string

      Unieke verzoekidentificatie.

    • response_time
      Type: number Formaat: float

      Tijd in seconden die nodig was om het verzoek te voltooien.

    • results
      Type: array object[]
      • favicon
        Type: string

        Favicon-URL van de gecrawlde pagina.

      • raw_content
        Type: string

        Geëxtraheerde ruwe inhoud van de pagina.

      • url
        Type: string

        URL van de gecrawlde pagina.

    • usage
      Type: object
      • credits
        Type: integer

        Details over creditgebruik voor het verzoek.

    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

    Foutrespons; upstream-passthrough-responsen kunnen indelingen van de provider gebruiken

    application/json
Request Example for post/v1/beta/tavily/crawl
curl https://openapi.felo.ai/v1/beta/tavily/crawl \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "url": "docs.tavily.com",
  "instructions": "",
  "chunks_per_source": 3,
  "max_depth": 1,
  "max_breadth": 20,
  "limit": 50,
  "select_paths": [
    ""
  ],
  "select_domains": [
    ""
  ],
  "exclude_paths": [
    ""
  ],
  "exclude_domains": [
    ""
  ],
  "allow_external": true,
  "include_images": false,
  "extract_depth": "basic",
  "format": "markdown",
  "include_favicon": false,
  "timeout": 150,
  "include_usage": false
}'
{
  "base_url": "string",
  "results": [
    {
      "url": "string",
      "raw_content": "string",
      "favicon": "string"
    }
  ],
  "response_time": 1,
  "usage": {
    "credits": 1
  },
  "request_id": "string"
}
Graph-based website traversal tool using Tavily Crawl.