> ## Documentation Index
> Fetch the complete documentation index at: https://docs.llmgenerator.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Einführung

> Überblick über die LLMGenerator-REST-API.

Willkommen in der Dokumentation der LLMGenerator-API. Unsere API ermöglicht programmatischen Zugriff auf die Kernfunktionen von LLMGenerator, sodass Sie die Erstellung und Verwaltung von `llms.txt` direkt in Ihre Anwendungen integrieren können.

## Basis-URL

Alle API-Endpunkte sind relativ zur folgenden Basis-URL:

```
https://api.llmgenerator.com/api/v1
```

## Authentifizierung

Die LLMGenerator-API verwendet API-Schlüssel zur Authentifizierung von Anfragen. Sie können Ihre API-Schlüssel unter [Einstellungen → API-Schlüssel](https://app.llmgenerator.com/settings/api-keys) erstellen und verwalten.

Alle authentifizierten Anfragen müssen einen `Authorization`-Header mit Ihrem API-Schlüssel als Bearer-Token enthalten.

```
Authorization: Bearer YOUR_API_KEY
```

<Warning>
  Halten Sie Ihre API-Schlüssel geheim. Teilen Sie sie nicht in öffentlich zugänglichen Bereichen wie GitHub oder clientseitigem Code.
</Warning>

## Generierungsmethoden

Die API unterstützt zwei verschiedene Generierungsmethoden:

| Methode      | Beschreibung                                                                       | Credit-Kosten |
| ------------ | ---------------------------------------------------------------------------------- | ------------- |
| **Simple**   | Schnelle Generierung auf Basis von Seitenmetadaten. Ideal für schnelle Ergebnisse. | 1x            |
| **Enhanced** | KI-gestützte Generierung mit verbesserten Titeln und Beschreibungen.               | 2x            |

Sie können die Methode über den Parameter `generationMethod` am Endpunkt `/generate` festlegen. Nutzer des Free-Tarifs können nur die Methode `simple` verwenden.

## Credit-System

Die API-Nutzung wird über Credits abgerechnet:

* **Simple-Generierung**: Basis-Credit-Kosten pro verarbeiteter URL
* **Enhanced-Generierung**: 2-facher Credit-Multiplikator für die KI-Verarbeitung
* **Volltext**: Zusätzliche Credits für die Einbindung des vollständigen Seiteninhalts

Ihr Kontostand ist über den Endpunkt `/credits/balance` abrufbar.

## Ratenbegrenzung

API-Anfragen sind abhängig von Ihrem Abonnement tariflich begrenzt. Bei Überschreitung erhalten Sie eine Antwort `429 Too Many Requests`. Die Antwortheader enthalten Informationen zur Ratenbegrenzung:

* `X-RateLimit-Limit`: Maximale Anfragen pro Minute
* `X-RateLimit-Remaining`: Verbleibende Anfragen im aktuellen Zeitfenster
* `X-RateLimit-Reset`: Zeitpunkt der Zurücksetzung des Fensters (Unix-Zeit in Sekunden, UTC)

## CORS-Unterstützung

Öffentliche Dateiendpunkte (`/file/:siteId`) unterstützen CORS und können direkt aus Browsern aufgerufen werden. Diese Endpunkte erfordern keine Authentifizierung.

## Fehler

Die API verwendet übliche HTTP-Statuscodes:

| Code  | Beschreibung                                           |
| ----- | ------------------------------------------------------ |
| `200` | Erfolg                                                 |
| `201` | Ressource erstellt                                     |
| `400` | Ungültige Anfrage (Validierungsfehler)                 |
| `401` | Nicht autorisiert (ungültiger/fehlender API-Schlüssel) |
| `403` | Verboten (unzureichende Berechtigungen)                |
| `404` | Ressource nicht gefunden                               |
| `429` | Ratenlimit überschritten                               |
| `500` | Interner Serverfehler                                  |

Fehlerantworten enthalten einen JSON-Body:

```json theme={null}
{
  "message": "Validation error: URL is required"
}
```

## Webhooks

Bei lang laufenden Vorgängen können Sie Webhook-URLs konfigurieren, um Benachrichtigungen bei Abschluss von Jobs zu erhalten. Wenden Sie sich an den Support, um Webhooks für Ihr Konto zu aktivieren.