Dokumentation

API für Einfache Sprache und Leichte Sprache.

Senden Sie Ihren Ausgangstext, die gewünschte Zielsprache und einen der beiden Sprachmodi. Simple8 erkennt die Ausgangssprache automatisch und gibt den fertigen Text in der Zielsprache zurück.

{
  "text": "Komplexer Ausgangstext in der ausgewählten Sprache.",
  "locale": "de",
  "mode": "simple-language"
}

SDK und cURL-Beispiele verfügbar

Endpunkt

POST /api/v2/translate

Erstellt einen Text in Einfacher oder Leichter Sprache und gibt ihn direkt in der HTTP-Antwort zurück.

Erforderliche Header

KopfbereichWertZweck
AuthorizationBearer <API_KEY>Authentifizierung des Arbeitsbereichs
Content-Typeapplication/jsonGibt an, dass die Anfrage JSON enthält
Acceptapplication/jsonFordert eine JSON-Antwort an
Idempotency-KeyNur für Hintergrund- und Sammelaufträge erforderlichVerhindert doppelte Hintergrundaufträge

Anforderungstext

Keine andere Inhaltseinstellung ist Teil des öffentlichen Anforderungsschemas.

FeldTypErforderlichZulässiger WertBeschreibung
textZeichenfolgeJa1 bis 5.000 NFC-normalisierte Unicode-CodepunkteAusgangstext
localeZeichenfolgeJaEiner von 136 unterstützten Codes mit 2 oder 3 BuchstabenAusgabesprache. Die Ausgangssprache wird automatisch erkannt.
modeZeichenfolgeJasimple-language, easy-languageVereinfachungsmodus
json
{
  "text": "Applicants must provide the required documentation before the deadline.",
  "locale": "en",
  "mode": "easy-language"
}

Antwortkörper

Die Antwort enthält den fertigen Text und die dokumentierten Nutzungsdaten.

FeldTypBeschreibung
requestIdZeichenfolgeEindeutige Kennung für Support und Protokolle
localeZeichenfolgeAusgewählte Zielsprache
modeZeichenfolgeAusgewählter Vereinfachungsmodus
outputZeichenfolgeFertiger Text in der ausgewählten Zielsprache
usage.inputCharactersganze ZahlFür diese Anfrage gezählte Zeichen oder 0 für einen Cache-Treffer
usage.cacheHitBoolescher WertOb das Ergebnis aus dem 180-Tage-Cache stammt
json
{
  "requestId": "req_sync_002",
  "locale": "en",
  "mode": "easy-language",
  "output": "You need to send documents.\nSend the documents before the deadline.",
  "usage": {
    "inputCharacters": 78,
    "cacheHit": false
  }
}

Validierungsverhalten

  • Fehlende, leere, unbekannte oder ungültige Felder führen zu HTTP 400 mit dem Fehlercode invalid_request und Validierungsdetails.
  • Die Textlänge wird nach der NFC-Normalisierung in Unicode-Codepunkten gemessen.
  • Das Gebietsschema muss einem der 136 dokumentierten Codes mit 2 oder 3 Buchstaben entsprechen.
  • Der Modus muss exakt simple-language oder easy-language sein.
  • Simple8 erkennt die Sprache des Ausgangstexts automatisch und erstellt das Ergebnis in der gewählten Zielsprache.

Simple8 kostenlos nutzen.

Erstellen Sie Ihr kostenloses Konto und nutzen Sie jeden Monat bis zu 15.000 Zeichen kostenlos.