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

Tavily-Suche

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

Tavily-Suche

​

Durchsucht das Web und gibt rangierte Ergebnisse mit Titeln, URLs und Inhaltsausschnitten zurück. query ist erforderlich. Mit max_results steuern Sie die Anzahl der Ergebnisse, mit search_depth wählen Sie den Suchmodus. Zusätzliche Antwort, Bilder und Rohinhalte werden nur auf Anfrage zurückgegeben. Setzen Sie include_usage, um Informationen zur Ressourcennutzung zu erhalten; usage.credits ist keine Felo-Gebühr.

Preisreferenz

  • Abrechnung: Abrechnete Antworteinheiten.
  • Referenzschätzung pro Anfrage: USD 0.016.
  • Kostenbasis pro Einheit: USD 0.008.
  • Ressourceneinheit: tavily_credit.
  • Referenz-Kundenmultiplikator: 1.0. Nicht erneut auf bereits abgerechnete Kundenbeträge anwenden.
  • Kostenbasen legen den endgültigen Kundenpreis nicht fest, auch nicht bei null.

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.

Body
erforderlich
application/json
  • query
    Typ: string
    erforderlich

    Die Suchanfrage, die mit Tavily ausgeführt wird.

  • auto_parameters
    Typ: boolean

    Suchparameter automatisch anhand des Inhalts der Suchanfrage konfigurieren.

  • chunks_per_source
    Typ: integer
    min.:  
    1
    max.:  
    3

    Maximale Anzahl relevanter Chunks, die pro Quelle zurückgegeben werden.

  • country
    Typ: string enum

    Suchergebnisse aus einem bestimmten Land bevorzugen. Nur verfügbar, wenn topic general ist.

    Werte
    • afghanistan
    • albania
    • algeria
    • andorra
    • angola
  • end_date
    Typ: string Format: date

    Ergebnisse vor dem angegebenen Enddatum zurückgeben.

  • exclude_domains
    Typ: array string[] …150

    Liste der Domains, die ausdrücklich von den Suchergebnissen ausgeschlossen werden sollen.

  • include_answer

    Eine LLM-generierte Antwort einschließen. true verwendet den Standard-Antwortmodus; basic oder advanced wählt den Modus zur Antworterzeugung.

    • Typ: boolean

      Eine LLM-generierte Antwort einschließen. true verwendet den Standard-Antwortmodus; basic oder advanced wählt den Modus zur Antworterzeugung.

  • include_domains
    Typ: array string[] …300

    Liste der Domains, die ausdrücklich in die Suchergebnisse aufgenommen werden sollen.

  • include_favicon
    Typ: boolean

    Die Favicon-URL für jedes Ergebnis einschließen.

  • include_image_descriptions
    Typ: boolean

    Beschreibenden Text für jedes Bild hinzufügen, wenn include_images true ist.

  • include_images
    Typ: boolean

    Eine Bildersuche durchführen und Ergebnisse einschließen.

  • include_raw_content

    Bereinigten und geparsten Inhalt für jedes Suchergebnis einschließen. true oder markdown gibt Markdown zurück; text gibt reinen Text zurück und kann die Latenz erhöhen.

    • Typ: boolean

      Bereinigten und geparsten Inhalt für jedes Suchergebnis einschließen. true oder markdown gibt Markdown zurück; text gibt reinen Text zurück und kann die Latenz erhöhen.

  • include_usage
    Typ: boolean

    Informationen zur Ressourcennutzung in die Antwort aufnehmen. Dies sind keine Felo-Abrechnungsinformationen.

  • max_results
    Typ: integer
    min.:  
    0
    max.:  
    20

    Maximale Anzahl der zurückzugebenden Suchergebnisse.

  • Typ: boolean

    Nicht jugendfreie oder unsichere Inhalte aus den Suchergebnissen herausfiltern. Nur Enterprise; nicht unterstützt, wenn search_depth fast oder ultra-fast ist.

  • search_depth
    Typ: string enum

    Steuert die Abwägung zwischen Latenz und Relevanz. advanced liefert die höchste Relevanz bei höherer Latenz und höheren Kosten; basic ist ausgewogen; fast und ultra-fast optimieren auf niedrigere Latenz.

    Werte
    • advanced
    • basic
    • fast
    • ultra-fast
  • start_date
    Typ: string Format: date

    Ergebnisse nach dem angegebenen Startdatum zurückgeben.

  • time_range
    Typ: string enum

    Zeitraum zum Filtern von Ergebnissen nach Veröffentlichungsdatum.

    Werte
    • day
    • week
    • month
    • year
    • d
    • w
    • m
    • y
  • topic
    Typ: string enum

    Kategorie der Suche.

    Werte
    • general
    • news
    • finance
Antworten
  • 200
    Typ: object

    Suchergebnisse erfolgreich zurückgegeben.

    • answer
      Typ: string | null

      Eine kurze, LLM-generierte Antwort. Ist null, wenn include_answer false ist oder keine Antwort generiert wird.

    • images
      Typ: array object[]
      • description
        Typ: string

        Bildbeschreibung.

      • url
        Typ: string

        Bild-URL.

    • query
      Typ: string

      Die Suchanfrage, die ausgeführt wurde.

    • request_id
      Typ: string

      Eindeutige Anfragekennung.

    • response_time
      Typ: number Format: float

      Zeit in Sekunden, die zum Abschließen der Anfrage benötigt wurde.

    • results
      Typ: array object[]
      • content
        Typ: string

        Inhalts-Snippet des Suchergebnisses.

      • favicon
        Typ: string | null

        Favicon-URL des Suchergebnisses.

      • raw_content
        Typ: string | null

        Bereinigter und geparster Quellinhalt. Null, außer wenn include_raw_content angefordert wird oder kein Rohinhalt verfügbar ist.

      • score
        Typ: number Format: float

        Relevanzwert des Suchergebnisses.

      • title
        Typ: string

        Titel des Suchergebnisses.

      • url
        Typ: string

        URL des Suchergebnisses.

    • usage
      Typ: object
      • credits
        Typ: integer

        Von dieser Anfrage verbrauchte Ressourceneinheiten, nicht USD oder Felo-Credits.

    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

    Fehlerantwort; Upstream-Passthrough-Antworten können Anbieterformate verwenden

    application/json
Request Example for post/v1/beta/tavily/search
curl --request POST https://openapi.felo.ai/v1/beta/tavily/search \
  --header "Authorization: Bearer ${FELO_API_KEY:?Set FELO_API_KEY}" \
  --header 'Content-Type: application/json' \
  --data '{"query": "Python official documentation", "search_depth": "basic", "max_results": 2, "include_usage": true}'

{
  "query": "Python official documentation",
  "answer": null,
  "images": [],
  "results": [
    {
      "title": "Python Documentation",
      "url": "https://docs.python.org/3/",
      "content": "Documentation for the Python programming language.",
      "score": 0.98,
      "raw_content": null
    }
  ],
  "response_time": 1.2,
  "usage": {
    "credits": 1
  },
  "request_id": "example-search-request"
}

Suchergebnisse erfolgreich zurückgegeben.

Tavily Search