Quick Start
Mit drei Schritten zur ersten Rechtschreibkorrektur:
- Registrieren und einen kostenlosen Account anlegen
- API Key im Dashboard unter API Keys generieren
- Request senden – fertig
cURL
curl -X POST https://framespell.pages.dev/api/spellcheck \
-H "X-API-Key: IHR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"text": "Das ist ein Beispeil text", "language": "de"}'
✅ Antwort: Sie erhalten sofort den korrigierten Text als JSON zurück – keine weiteren Setup-Schritte nötig.
Authentifizierung
Jeder API-Request benötigt einen gültigen API Key, der im HTTP-Header X-API-Key übermittelt wird.
Header
X-API-Key: fs_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json
⚠ Sicherheit: API Keys niemals im Frontend/Browser-JavaScript oder in Git-Repositories speichern. Immer Umgebungsvariablen verwenden.
API Key generieren
- Auf der Startseite registrieren und anmelden
- Im Dashboard zu API Keys navigieren
- Auf Neu generieren klicken – den Key sofort kopieren (wird nur einmal angezeigt)
Endpunkte
Rechtschreibkorrektur
POST
https://framespell.pages.dev/api/spellcheck
Request-Parameter
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
text | string | ✓ | Der zu korrigierende Text (max. 5.000 Zeichen) |
language | string | ✓ | Sprachcode: de (weitere folgen) |
Request Body
{
"text": "Das ist ein Beispeil text mit felern",
"language": "de"
}Response-Format
Erfolgreiche Antwort (HTTP 200):
JSON Response
{
"success": true,
"data": {
"corrected": "Das ist ein Beispieltext mit Fehlern",
"original": "Das ist ein Beispeil text mit felern",
"processing_time": 143.7,
"tokens_used": 8
}
}| Feld | Typ | Beschreibung |
|---|---|---|
corrected | string | Korrigierter Text |
original | string | Originaltext wie eingereicht |
processing_time | number | Verarbeitungszeit in Millisekunden |
tokens_used | number | Verbrauchte Tokens (für Billing relevant) |
Rate Limits
| Plan | Limit | Überschreitung |
|---|---|---|
| Free | 20 Anfragen / Minute | 1 Token pro weitere Anfrage |
| Professional | 100 Anfragen / Minute | Flatrate – keine Zusatzkosten |
| Enterprise | Unbegrenzt | Individuell verhandelt |
Bei Überschreitung des Limits antwortet die API mit HTTP 429 und einem retry_after Feld (Sekunden):
{
"success": false,
"error": "Rate limit exceeded",
"retry_after": 8
}Fehler & Status Codes
| Status | Bedeutung | Empfohlene Reaktion |
|---|---|---|
| 200 | Erfolg | Ergebnis verarbeiten |
| 400 | Bad Request – fehlerhafte Anfrage | Request-Body prüfen, kein Retry |
| 401 | Unauthorized – ungültiger API Key | Key prüfen, kein Retry |
| 429 | Rate Limit überschritten | Exponential Backoff + Retry |
| 500 | Server Error | Einmal nach 2s erneut versuchen |
Unterstützte Sprachen
| Sprache | Code | Status |
|---|---|---|
| 🇩🇪 Deutsch | de | ✓ Verfügbar |
| 🇬🇧 Englisch | en | ⏳ In Entwicklung |
| 🇪🇸 Spanisch | es | ⏳ In Entwicklung |
| 🇫🇷 Französisch | fr | ⏳ In Entwicklung |
Codebeispiele
JavaScript (fetch)
JavaScript
const response = await fetch(
'https://framespell.pages.dev/api/spellcheck',
{
method: 'POST',
headers: {
'Content-Type': 'application/json',
'X-API-Key': process.env.FRAMESPELL_API_KEY
},
body: JSON.stringify({ text: 'Beispeil text', language: 'de' })
}
);
const { success, data } = await response.json();
if (success) console.log(data.corrected);Python
Python
import os, requests
resp = requests.post(
'https://framespell.pages.dev/api/spellcheck',
json={'text': 'Beispeil text', 'language': 'de'},
headers={'X-API-Key': os.environ['FRAMESPELL_API_KEY']},
timeout=10
)
result = resp.json()
print(result['data']['corrected'])cURL
cURL
curl -X POST https://framespell.pages.dev/api/spellcheck \
-H "X-API-Key: IHR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"text": "Beispeil text", "language": "de"}'
📖 Mehr Details? Der Integration Guide erklärt Error Handling, Batch-Verarbeitung, TypeScript-Typen und Next.js-Integration ausführlich.