Dokumentation

Legen Sie fest, wie Ihr System das Ergebnis erhält.

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

SDK und cURL-Beispiele verfügbar

Synchrones HTTP

Jedes Muster verwendet dieselben Kernfelder: Text, Sprachcode und Modus.

Endpunkt

POST /api/v2/translate

Am besten für

Kurze Inhalte und direkte Backend-Aktionen.

Erfolg

200 OK

Streaming

Die Antwort verwendet Content-Type: text/event-stream.

Endpunkt

POST /api/v2/translate/stream

Am besten für

Progressive Schnittstellen und längere Inhalte.

json
{
  "text": "Source content in the selected language.",
  "locale": "en",
  "mode": "easy-language"
}
text
event: meta
data: {"requestId":"req_stream_001","locale":"en","mode":"easy-language"}

event: delta
data: {"delta":"Complete result."}

event: done
data: {"usage":{"inputCharacters":42,"cacheHit":false}}

Der Stream gibt ein Meta-Ereignis, ein oder mehrere Delta-Ereignisse und ein abschließendes Fertig-Ereignis aus.

Das Metaereignis enthält die Anforderungskennung, das Sprachcode und den Modus.

Jedes Delta enthält einen Teil des Ergebnisses und done enthält die Nutzungsinformationen.

Anschließend wird die Verbindung geschlossen.

Asynchroner Job mit Abfrage

Senden Sie beim Erstellen eines Jobs einen eindeutigen Idempotency-Key-Header.

Endpunkt erstellen

POST /api/v2/jobs

Statusendpunkt

GET /api/v2/jobs/{id}

json
{
  "text": "Source content in the selected language.",
  "locale": "fr",
  "mode": "simple-language",
  "delivery": {
    "type": "polling"
  }
}
json
{
  "jobId": "job_poll_001",
  "status": "queued"
}
json
{
  "jobId": "job_poll_001",
  "status": "completed",
  "locale": "fr",
  "mode": "simple-language",
  "output": {
    "text": "Simplified content in French."
  }
}

Jobs bleiben sieben Tage lang verfügbar.

Führen Sie in angemessenen Abständen eine Abfrage durch, bis der Status abgeschlossen oder fehlgeschlagen ist.

Asynchroner Job mit Webhook

Erstellen und prüfen Sie zunächst einen Webhook-Endpunkt in der Simple8-Anwendung. Verweisen Sie dann im Job auf die Endpunkt-ID.

Endpunkt erstellen

POST /api/v2/jobs

json
{
  "text": "Source content in the selected language.",
  "locale": "de",
  "mode": "easy-language",
  "delivery": {
    "type": "webhook",
    "endpointId": "00000000-0000-4000-8000-000000000000"
  }
}
json
{
  "id": "evt_01",
  "type": "job.completed",
  "createdAt": "2026-08-06T12:00:00.000Z",
  "data": {
    "jobId": "job_hook_001",
    "status": "completed"
  }
}

Simple8 sendet einen Simple8-Signature-Header mit einem Zeitstempel und einer HMAC SHA-256-Signatur.

Prüfen Sie die Signatur anhand des Rohanforderungstexts, wobei das Signaturgeheimnis einmal beim Erstellen des Endpunkts angezeigt wird.

Gibt einen beliebigen 2xx-Status zurück, nachdem das Ereignis akzeptiert wurde.

Fehlgeschlagene Zustellungen werden innerhalb von sieben Tagen bis zu 50 Mal wiederholt und die letzten Versuche werden in der Anwendung angezeigt.

Empfänger müssen eine doppelte Zustellung tolerieren, da Wiederholungsversuche dasselbe Ereignis mehr als einmal übermitteln können.

Stapelverarbeitung

Senden Sie zwischen 1 und 50 Artikel mit insgesamt maximal 500.000 Zeichen.

Endpunkt erstellen

POST /api/v2/batches

Statusendpunkt

GET /api/v2/batches/{id}

Jedes Element verwendet dieselben Text-, Sprachcode- und Modusfelder wie eine synchrone Anfrage.

Wählen Sie Polling oder einen verifizierten Webhook-Endpunkt für die Zustellung und senden Sie einen eindeutigen Idempotency-Key-Header.