# Tavily-Extraktion

**API:** Data API

**Endpoint:** `POST /v1/beta/tavily/extract`

**Tags:** Web Content

Extrahiert lesbaren Inhalt aus einer URL oder einem Array von URLs. Wählen Sie mit format Text oder Markdown. Prüfen Sie sowohl results als auch failed_results: Eine fehlgeschlagene URL kann in einer ansonsten erfolgreichen HTTP-Antwort gemeldet werden. 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.024.
- 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.

## Base URL

- `https://openapi.felo.ai`

## Authentication

- `FeloBearerAuth` (http bearer, bearer format Felo API Key)
- `FeloApiKey` (apiKey in header `X-API-Key`)

## Request body

Required: **yes**

### application/json

Schema:

```json
{
  "type": "object",
  "properties": {
    "urls": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ],
      "description": "Die URL oder URLs, aus denen Inhalte extrahiert werden sollen. Eine einzelne URL-Zeichenkette und ein Array von URL-Zeichenketten werden beide akzeptiert.",
      "example": [
        "https://en.wikipedia.org/wiki/Artificial_intelligence"
      ]
    },
    "query": {
      "type": "string",
      "description": "Nutzerabsicht für das Reranking extrahierter Inhalts-Chunks."
    },
    "chunks_per_source": {
      "type": "integer",
      "default": 3,
      "description": "Maximale Anzahl relevanter Chunks, die pro Quelle zurückgegeben werden. Nur verfügbar, wenn query angegeben ist.",
      "minimum": 1,
      "maximum": 5
    },
    "extract_depth": {
      "type": "string",
      "enum": [
        "basic",
        "advanced"
      ],
      "default": "basic",
      "description": "Tiefe des Extraktionsvorgangs."
    },
    "include_images": {
      "type": "boolean",
      "default": false,
      "description": "Eine Liste der aus den URLs extrahierten Bilder einschließen."
    },
    "include_favicon": {
      "type": "boolean",
      "default": false,
      "description": "Die Favicon-URL für jedes Ergebnis einschließen."
    },
    "format": {
      "type": "string",
      "enum": [
        "markdown",
        "text"
      ],
      "default": "markdown",
      "description": "Format des extrahierten Webseiteninhalts."
    },
    "timeout": {
      "type": "number",
      "format": "float",
      "description": "Maximale Wartezeit in Sekunden für die URL-Extraktion. Wenn sie weggelassen wird, hängen die Standard-Timeouts von extract_depth ab: 10 Sekunden für basic und 30 Sekunden für advanced.",
      "minimum": 1,
      "maximum": 60
    },
    "include_usage": {
      "type": "boolean",
      "default": false,
      "description": "Informationen zur Ressourcennutzung in die Antwort aufnehmen. Dies sind keine Felo-Abrechnungsinformationen."
    }
  },
  "required": [
    "urls"
  ]
}
```

Example:

```json
{
  "urls": [
    "https://example.com"
  ],
  "extract_depth": "basic",
  "format": "text",
  "include_usage": true
}
```

## Responses

### 200 — Extraktionsergebnisse erfolgreich zurückgegeben.

Headers:
- `X-Request-Id` (string) — Anfragekennung, die Sie beim Kontakt mit dem Felo-Support angeben sollten.

**application/json**

Schema: object

```json
{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string",
            "description": "URL des extrahierten Inhalts."
          },
          "title": {
            "type": "string",
            "description": "Titel der extrahierten Seite."
          },
          "raw_content": {
            "type": "string",
            "description": "Extrahierter Rohinhalt aus der URL."
          },
          "images": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Aus der URL extrahierte Bilder, wenn include_images true ist."
          },
          "favicon": {
            "type": [
              "string",
              "null"
            ],
            "description": "Favicon-URL des extrahierten Inhalts."
          }
        }
      }
    },
    "failed_results": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Liste der URLs, die nicht verarbeitet werden konnten."
    },
    "response_time": {
      "type": "number",
      "format": "float",
      "description": "Zeit in Sekunden, die zum Abschließen der Anfrage benötigt wurde."
    },
    "usage": {
      "type": "object",
      "properties": {
        "credits": {
          "type": "integer",
          "description": "Von dieser Anfrage verbrauchte Ressourceneinheiten, nicht USD oder Felo-Credits."
        }
      }
    },
    "request_id": {
      "type": "string",
      "description": "Eindeutige Anfragekennung."
    }
  }
}
```

Example:

```json
{
  "results": [
    {
      "url": "https://example.com",
      "title": "Example Domain",
      "raw_content": "This domain is for use in documentation examples.",
      "images": []
    }
  ],
  "failed_results": [],
  "response_time": 0.5,
  "usage": {
    "credits": 1
  },
  "request_id": "example-extract-request"
}
```

### 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**

Schema:

```json
{}
```
