Documentatie

Kies hoe je systeem het resultaat ontvangt.

{
  "text": "Complexe broninhoud in de geselecteerde taal.",
  "locale": "nl",
  "mode": "simple-language"
}

SDK- en cURL-voorbeelden beschikbaar

Synchrone HTTP

Vergelijk directe antwoorden, streaming, achtergrondtaken en webhooks. Alle varianten gebruiken tekst, taalcode en modus.

Eindpunt

POST /api/v2/translate

Het beste voor

Korte teksten, waarvan het resultaat onmiddellijk nodig is.

Succes

200 Goed

Streaming

Het antwoord maakt gebruik van Content-Type: text/event-stream.

Eindpunt

POST /api/v2/translate/stream

Het beste voor

Voor langere inhoud, waarvan het resultaat geleidelijk moet worden weergegeven.

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}}

De stroom begint met Meta. Dit wordt gevolgd door een of meer delen van de tekst als delta. De voltooide gebeurtenis vult het antwoord aan met de gebruiksgegevens.

De eerste gebeurtenis bevat het verzoek ID, de spraakcode en de modus.

Elke delta bevat een deel van het resultaat en done bevat de gebruiksinformatie.

Als u klaar bent, wordt de verbinding gesloten.

Asynchrone werk met polling

Stuur een unieke Idempotency-Key-header bij het maken van een taak. Gebruik bij nieuwe pogingen dezelfde sleutel zonder spaties aan het begin of einde, met een lengte van 1 tot 255 tekens. De eerste aanmaak retourneert 202 en een herhaling retourneert 200.

Skep endpoint

POST /api/v2/jobs

Status eindpunt

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",
  "expiresAt": "2026-09-03T12:00:00.000Z"
}
json
{
  "jobId": "job_poll_001",
  "status": "completed",
  "locale": "fr",
  "mode": "simple-language",
  "output": "Simplified content in French.",
  "expiresAt": "2026-09-03T12:00:00.000Z"
}

Vacatures blijven zeven dagen beschikbaar.

Een taak doorloopt queued, processing, completed of failed. Mislukte taken bevatten error.code. Aanmaak- en statusreacties bevatten expiresAt.

Vraag eerst na één seconde opnieuw om de status. Verhoog de afstand geleidelijk met langere verwerking.

Asynchronisatie met webhook

Maak en verifieer eerst een webhookeindpunt in de Simple8-applicatie. Verwijs vervolgens naar de eindpunt-ID in de taak.

Skep endpoint

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 verzendt Simple8-Signature als t=<timestamp>,v1=<signature>. <timestamp> is een Unix-tijdstempel in seconden. De handtekening is de hexadecimale uitvoer in kleine letters van een HMAC SHA-256 over <timestamp>.<raw request body>.

Controleer de handtekening tegen het ongewijzigde verzoek. U ziet de geheime handtekening sleutel zodra u het eindpunt.

Retourneer HTTP 200 of 201 zodra je systeem de gebeurtenis accepteert.

Herhaalt: In het geval van een fout, Simple8 probeert levering tot 50 keer binnen zeven dagen. Je kunt de laatste pogingen in de toepassing zien.

Gebeurtenissen dupliceren: Bewerk elke gebeurtenis-ID slechts één keer, omdat een herhaling dezelfde gebeurtenis opnieuw kan verzenden.

Batchverwerking

Verzend tussen 1 en 50 items met een gecombineerd maximum van 25.000 tekens.

Skep endpoint

POST /api/v2/batches

Status eindpunt

GET /api/v2/batches/{id}

Elk item gebruikt dezelfde tekst-, landinstelling- en modusvelden als een synchrone aanvraag.

Kies polling of een geverifieerd webhook-eindpunt voor levering en stuur een unieke Idempotency-Key-header.

json
{
  "items": [
    {
      "text": "First source text.",
      "locale": "en",
      "mode": "simple-language"
    },
    {
      "text": "Second source text.",
      "locale": "de",
      "mode": "easy-language"
    }
  ],
  "delivery": {
    "type": "polling"
  }
}
json
{
  "batchId": "batch_001",
  "status": "queued",
  "itemCount": 2
}
json
{
  "batchId": "batch_001",
  "status": "completed",
  "itemCount": 2,
  "items": [
    {
      "jobId": "job_001",
      "status": "completed",
      "locale": "en",
      "mode": "simple-language",
      "output": "First result."
    },
    {
      "jobId": "job_002",
      "status": "failed",
      "locale": "de",
      "mode": "easy-language",
      "error": {
        "code": "processing_failed"
      }
    }
  ]
}

Het aanmaken van een batch retourneert de eerste keer HTTP 202 en bij een idempotente herhaling HTTP 200. De webhookgebeurtenissen zijn job.completed, job.failed, batch.completed en batch.failed. Payloads van voltooide webhooks bevatten alleen identificatoren en status. Haal de uitvoer op via het status-endpoint van de taak of batch.

Begin gratis met het gebruik van Simple8.

Maak uw gratis account aan en gebruik elke maand gratis maximaal 15.000 tekens.