API-REFERENZ
Vereinfachen Sie Inhalte und übersetzen Sie sie in 24 Ausgabesprachen.
Der synchrone Endpunkt akzeptiert Quelltext, ein Ausgabesprache und einen von zwei Modi. Es erkennt die Quellsprache automatisch und liefert ein gebrauchsfertiges Ergebnis in der ausgewählten Ausgabesprache.
{
"text": "Komplexer Ausgangstext in der ausgewählten Sprache.",
"locale": "de",
"mode": "simple-language"
}SDK und cURL-Beispiele verfügbar
Endpunkt
POST /api/v2/translate
Erstellen Sie ein Einfache Sprache- oder Leichte Sprache-Ergebnis und geben Sie es in derselben HTTP-Antwort zurück.
Erforderliche Header
| Kopfbereich | Wert | Zweck |
|---|---|---|
| Authorization | Bearer <API_KEY> | Authentifiziert das Projekt mit dem aktuellen HTTP-Bearer-Schema |
| Content-Type | application/json | Deklariert das Format des Anforderungstexts |
| Accept | application/json | Fordert eine JSON-Antwort an |
| Idempotency-Key | Nur für Jobs und Batches erforderlich | Verhindert, dass wiederholte asynchrone Übermittlungen doppelte Arbeit verursachen |
Anforderungstext
Keine andere Inhaltseinstellung ist Teil des öffentlichen Anforderungsschemas.
| Feld | Typ | Erforderlich | Zulässiger Wert | Beschreibung |
|---|---|---|---|---|
| text | Zeichenfolge | Ja | 1 bis 10.000 Unicode-Zeichen | Quellinhalt im ausgewählten Sprachcode |
| locale | Zeichenfolge | Ja | Einer von 24 unterstützten Zwei-Buchstaben-Codes | Ausgabesprache. Die Ausgangssprache wird automatisch erkannt. |
| mode | Zeichenfolge | Ja | Einfache Sprache, Leichte Sprache | Vereinfachungsmodus |
{
"text": "Applicants must provide the required documentation before the deadline.",
"locale": "en",
"mode": "easy-language"
}Antwortkörper
Die Antwort darf keine zurückgezogenen Anforderungseinstellungen oder ein separates Qualitätsinformationsarray enthalten.
| Feld | Typ | Beschreibung |
|---|---|---|
| requestId | Zeichenfolge | Eindeutige Kennung für Support und Protokolle |
| locale | Zeichenfolge | Ausgewähltes Ausgabesprache |
| mode | Zeichenfolge | Ausgewählter Vereinfachungsmodus |
| output | Zeichenfolge | Fertiges Ergebnis im ausgewählten Ausgabesprache |
| usage.inputCharacters | ganze Zahl | Für diese Anfrage gezählte Zeichen oder 0 für einen Cache-Treffer |
| usage.cacheHit | Boolescher Wert | Ob das Ergebnis aus dem 30-Tage-Cache stammt |
{
"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
- Fehlender Text: Mit einem dokumentierten Feldfehler ablehnen.
- Leerer Text: Mit einem dokumentierten Feldfehler ablehnen.
- Nicht unterstütztes Sprachcode: ablehnen; Ersetzen Sie niemals stillschweigend ein anderes Sprachcode.
- Nicht unterstützter Modus: ablehnen; Wählen Sie niemals automatisch einen Modus aus.
- Unbekanntes ausgemustertes Feld: Mit einem migrationsbezogenen Fehler ablehnen oder nur über eine explizit versionierte Kompatibilitätsschicht verarbeiten.
- Der Quelltext verwendet möglicherweise eine andere Sprache als das Sprachcode. Simple8 erkennt die Quellsprache automatisch und schreibt das Ergebnis in das ausgewählte Ausgabesprache.