# Tavily-extractie

**API:** Data API

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

**Tags:** Web Content

Extraheert leesbare inhoud uit één URL of een reeks URL's. Kies met format tekst of Markdown. Controleer zowel results als failed_results: een mislukte URL kan in een verder geslaagde HTTP-respons worden gemeld. Stel include_usage in om informatie over resourcegebruik te ontvangen; usage.credits is geen Felo-kostenpost.

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

## 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": "De URL of URL's waaruit inhoud moet worden geëxtraheerd. Een enkele URL-tekenreeks en een array van URL-tekenreeksen worden beide geaccepteerd.",
      "example": [
        "https://en.wikipedia.org/wiki/Artificial_intelligence"
      ]
    },
    "query": {
      "type": "string",
      "description": "Gebruikersintentie voor het herrangschikken van geëxtraheerde inhoudschunks."
    },
    "chunks_per_source": {
      "type": "integer",
      "default": 3,
      "description": "Maximaal aantal relevante chunks dat per bron wordt geretourneerd. Alleen beschikbaar wanneer query is opgegeven.",
      "minimum": 1,
      "maximum": 5
    },
    "extract_depth": {
      "type": "string",
      "enum": [
        "basic",
        "advanced"
      ],
      "default": "basic",
      "description": "Diepte van het extractieproces."
    },
    "include_images": {
      "type": "boolean",
      "default": false,
      "description": "Een lijst opnemen met afbeeldingen die uit de URL's zijn geëxtraheerd."
    },
    "include_favicon": {
      "type": "boolean",
      "default": false,
      "description": "De favicon-URL voor elk resultaat opnemen."
    },
    "format": {
      "type": "string",
      "enum": [
        "markdown",
        "text"
      ],
      "default": "markdown",
      "description": "Formaat van de geëxtraheerde webpagina-inhoud."
    },
    "timeout": {
      "type": "number",
      "format": "float",
      "description": "Maximale wachttijd in seconden voor URL-extractie. Als dit wordt weggelaten, zijn de standaardtime-outs afhankelijk van extract_depth: 10 seconden voor basic en 30 seconden voor advanced.",
      "minimum": 1,
      "maximum": 60
    },
    "include_usage": {
      "type": "boolean",
      "default": false,
      "description": "Informatie over resourcegebruik opnemen in de respons. Dit zijn geen Felo-factureringsgegevens."
    }
  },
  "required": [
    "urls"
  ]
}
```

Example:

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

## Responses

### 200 — Extractieresultaten succesvol geretourneerd.

Headers:
- `X-Request-Id` (string) — Verzoekidentificatie die je moet meesturen wanneer je contact opneemt met Felo-ondersteuning.

**application/json**

Schema: object

```json
{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string",
            "description": "URL van de geëxtraheerde inhoud."
          },
          "title": {
            "type": "string",
            "description": "Titel van de geëxtraheerde pagina."
          },
          "raw_content": {
            "type": "string",
            "description": "Geëxtraheerde ruwe inhoud van de URL."
          },
          "images": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Afbeeldingen die uit de URL zijn geëxtraheerd wanneer include_images true is."
          },
          "favicon": {
            "type": [
              "string",
              "null"
            ],
            "description": "Favicon-URL van de geëxtraheerde inhoud."
          }
        }
      }
    },
    "failed_results": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Lijst met URL's die niet konden worden verwerkt."
    },
    "response_time": {
      "type": "number",
      "format": "float",
      "description": "Tijd in seconden die nodig was om het verzoek te voltooien."
    },
    "usage": {
      "type": "object",
      "properties": {
        "credits": {
          "type": "integer",
          "description": "Door dit verzoek verbruikte resource-eenheden, niet USD of Felo-credits."
        }
      }
    },
    "request_id": {
      "type": "string",
      "description": "Unieke verzoekidentificatie."
    }
  }
}
```

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

Schema:

```json
{}
```
