Dokumentation

Välj hur ditt system får resultatet.

{
  "text": "Komplext källinnehåll på det valda språket.",
  "locale": "sv",
  "mode": "simple-language"
}

SDK- och cURL-exempel tillgängliga

Synkront HTTP

Jämför direkta svar, streaming, bakgrundsjobb och webhooks. Alla varianter använder text, språkkod och läge.

Slutpunkt

POST /api/v2/translate

Bäst för

Korta texter, vars resultat behövs omedelbart.

Framgång

200 OK

Streaming

Svaret använder Content-Type: text/event-stream.

Slutpunkt

POST /api/v2/translate/stream

Bäst för

För längre innehåll, vars resultat bör visas gradvis.

{
  "text": "Source content in the selected language.",
  "locale": "en",
  "mode": "easy-language"
}

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

strömmen börjar med meta. Detta följs av en eller flera delar av texten som delta. Den färdiga händelsen slutför svaret med användningsdata.

Den första händelsen innehåller begäran ID, röstkoden och läget.

Varje delta innehåller en del av resultatet och gjort innehåller användningsinformationen.

Efter det stänger anslutningen.

Asynchroniserad arbetsplats med val

Idempotency-Key förhindrar dubbla jobb när du skickar en begäran igen efter en timeout eller ett anslutningsfel. Välj en ny nyckel för varje nytt jobb, till exempel ett UUID. Du skapar denna identifierare för begäran själv; den är inte din API-nyckel.

Skapa slutpunkt

POST /api/v2/jobs

Slutpunkt för status

GET /api/v2/jobs/{id}

Använd 1 till 255 tecken: A-Z, a-z, 0-9, punkter (.), understreck (_), kolon (:) eller bindestreck (-). Använd inte blanksteg och förkorta inte nyckeln. Skicka samma nyckel och samma begärandekropp vid varje nytt försök.

Det första skapandet returnerar HTTP 202. Samma begäran igen returnerar HTTP 200 med det befintliga jobbets ID. Samma nyckel med en annan begäran returnerar HTTP 409. Samma regler gäller för batcher. Exemplen nedan innehåller headern; ersätt varje exempelnyckel en gång för varje nytt jobb eller ny batch.

curl https://api.simple8.de/api/v2/jobs \
  -H "Authorization: Bearer $SIMPLE8_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: article-4711-v1" \
  -d '{
  "text": "Source content in the selected language.",
  "locale": "fr",
  "mode": "simple-language",
  "delivery": {
    "type": "polling"
  }
}'

{
  "jobId": "job_poll_001",
  "status": "queued",
  "expiresAt": "2026-09-03T12:00:00.000Z"
}

{
  "jobId": "job_poll_001",
  "status": "completed",
  "locale": "fr",
  "mode": "simple-language",
  "output": "Simplified content in French.",
  "expiresAt": "2026-09-03T12:00:00.000Z"
}

Jobben finns kvar i sju dagar.

Ett jobb går igenom queued, processing, completed eller failed. Misslyckade jobb innehåller error.code. Svar vid skapande och status innehåller expiresAt.

Fråga först status igen efter en sekund. Öka avståndet gradvis med längre bearbetning.

Asynchroniseringsarbete med webhook

Skapa och verifiera en webhook-slutpunkt i Simple8-applikationen först. Referera sedan till dess slutpunkts-ID i jobbet.

Skapa slutpunkt

POST /api/v2/jobs

curl https://api.simple8.de/api/v2/jobs \
  -H "Authorization: Bearer $SIMPLE8_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: article-4711-webhook-v1" \
  -d '{
  "text": "Source content in the selected language.",
  "locale": "de",
  "mode": "easy-language",
  "delivery": {
    "type": "webhook",
    "endpointId": "00000000-0000-4000-8000-000000000000"
  }
}'

{
  "id": "evt_01",
  "type": "job.completed",
  "createdAt": "2026-08-06T12:00:00.000Z",
  "data": {
    "jobId": "job_hook_001",
    "status": "completed"
  }
}

Simple8 skickar Simple8-Signature som t=<timestamp>,v1=<signature>. <timestamp> är en Unix-tidsstämpel i sekunder. Signaturen är det gemena hexadecimala resultatet av en HMAC SHA-256 över <timestamp>.<raw request body>.

Kontrollera signaturen mot den oförändrade begäran. Du kommer att se den hemliga signaturnyckeln när du skapar slutpunkten.

Returnera HTTP 200 eller 201 så snart systemet har accepterat händelsen.

Upprepa: I händelse av ett fel försöker Simple8 leverera upp till 50 gånger inom sju dagar. Du kan se de sista försöken i programmet.

Duplicera händelser: Bearbeta varje händelse ID bara en gång, som en upprepning kan skicka samma händelse.

Batchbearbetning

Skicka mellan 1 och 50 objekt med sammanlagt max 25 000 tecken.

Skapa slutpunkt

POST /api/v2/batches

Slutpunkt för status

GET /api/v2/batches/{id}

Varje objekt använder samma text-, språk- och lägesfält som en synkron begäran.

Välj polling eller en verifierad webhook-slutpunkt för leverans och skicka ett unikt Idempotency-Key-huvud.

curl https://api.simple8.de/api/v2/batches \
  -H "Authorization: Bearer $SIMPLE8_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: release-4711-v1" \
  -d '{
  "items": [
    {
      "text": "First source text.",
      "locale": "en",
      "mode": "simple-language"
    },
    {
      "text": "Second source text.",
      "locale": "de",
      "mode": "easy-language"
    }
  ],
  "delivery": {
    "type": "polling"
  }
}'

{
  "batchId": "batch_001",
  "status": "queued",
  "itemCount": 2
}

{
  "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"
      }
    }
  ]
}

När en batch skapas returneras HTTP 202 första gången och HTTP 200 vid en idempotent upprepning. Webhook-händelserna är job.completed, job.failed, batch.completed och batch.failed. Payloads för slutförda webhooks innehåller endast identifierare och status. Hämta utdata från status-endpointen för jobbet eller batchen.

På den här sidan

Välj hur ditt system får resultatet.

Börja använda Simple8 gratis.