Dokumentacija

Izberite, kako vaš sistem prejme rezultat.

{
  "text": "Kompleksna izvorna vsebina v izbranem jeziku.",
  "locale": "sl",
  "mode": "simple-language"
}

Na voljo so primeri SDK in cURL

Sinkronni HTTP

Primerjajte neposredne odgovore, pretakanje, delovna mesta v ozadju in webhooks. Vse variante uporabljajo besedilo, jezikovno kodo in način.

Končna točka

POST /api/v2/translate

Najboljša za

Kratka besedila, katerih rezultat je potreben takoj.

Uspeh

200 v redu.

Streaming

Odgovor uporablja Content-Type: text/event-stream.

Končna točka

POST /api/v2/translate/stream

Najboljša za

Za daljše vsebine, katerih rezultat je treba prikazati postopoma.

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

Potok se začne z meta. Temu sledi en ali več delov besedila kot delta. Dokončani dogodek dopolnjuje odziv s podatki o uporabi.

Prvi dogodek vsebuje ID zahteve, glasovno kodo in način.

Vsak delta vsebuje del rezultata in done vsebuje informacije o uporabi.

Po končanem se povezava prekine.

Neodveden delovni čas z anketajo

Idempotency-Key preprečuje podvojena opravila, ko zahtevo pošljete znova po časovni omejitvi ali napaki povezave. Za vsako novo opravilo izberite nov ključ, na primer UUID. Ta identifikator zahteve ustvarite sami; to ni vaš ključ API.

Ustvarjanje končne točke

POST /api/v2/jobs

Končna točka stanja

GET /api/v2/jobs/{id}

Uporabite od 1 do 255 znakov: A-Z, a-z, 0-9, pike (.), podčrtaje (_), dvopičja (:) ali vezaje (-). Ne uporabljajte presledkov in ne krajšajte ključa. Pri vsakem ponovnem poskusu pošljite isti ključ in isto telo zahteve.

Prvo ustvarjanje vrne HTTP 202. Ponovitev iste zahteve vrne HTTP 200 z ID-jem obstoječega opravila. Isti ključ z drugačno zahtevo vrne HTTP 409. Ista pravila veljajo za pakete. Spodnji primeri vključujejo glavo; vsak vzorčni ključ zamenjajte enkrat za vsako novo opravilo ali paket.

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

Delovna mesta ostanejo na voljo sedem dni.

Opravilo prehaja skozi stanja queued, processing, completed ali failed. Neuspela opravila vsebujejo error.code. Odgovori ob ustvarjanju in preverjanju stanja vsebujejo expiresAt.

Najprej vprašajte za status po eni sekundi. Z daljšo obdelavo postopoma povečajte razdaljo.

Async delo z webhook

Najprej ustvarite in preverite končno točko webhook v aplikaciji Simple8. Nato se v opravilu sklicujte na njegov ID končne točke.

Ustvarjanje končne točke

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 pošlje Simple8-Signature v obliki t=<timestamp>,v1=<signature>. <timestamp> je časovni žig Unix v sekundah. Podpis je šestnajstiški rezultat HMAC SHA-256 nad <timestamp>.<raw request body>, zapisan z malimi črkami.

Preverite podpis na nespremenjeni zahtevi. Ko ustvarite končno točko, boste videli skrivni podpisni ključ.

Vrni HTTP 200 ali 201 takoj, ko sistem sprejme dogodek.

Ponavljam: V primeru napake, Simple8 poskuša dostavo do 50-krat v sedmih dneh. Zadnji poskusi v prijavi so vidni.

Podvoji dogodke: Obdelaj ID vsakega dogodka samo enkrat, saj lahko ponavljanje ponovi isti dogodek.

Paketna obdelava

Pošljite od 1 do 50 elementov s skupno največ 25.000 znaki.

Ustvarjanje končne točke

POST /api/v2/batches

Končna točka stanja

GET /api/v2/batches/{id}

Vsak element uporablja isto besedilo, področne nastavitve in polja načina kot sinhrona zahteva.

Za dostavo izberite anketiranje ali preverjeno končno točko webhook in pošljite edinstveno glavo Idempotency-Key.

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

Ustvarjanje paketa prvič vrne HTTP 202, ob idempotentni ponovitvi pa HTTP 200. Webhook dogodki so job.completed, job.failed, batch.completed in batch.failed. Payloadi zaključenih webhookov vsebujejo samo identifikatorje in stanje. Rezultat pridobi iz endpointa stanja opravila ali paketa.

Na tej strani

Izberite, kako vaš sistem prejme rezultat.

Začnite uporabljati Simple8 brezplačno.