Dokumentatsioon

Vali, kuidas teie süsteem saab tulemust.

{
  "text": "Keeruline lähtesisu valitud keeles.",
  "locale": "et",
  "mode": "simple-language"
}

Saadaval on SDK ja cURL-i näited

Sinkroonne HTTP

Võrdle otsuseid, Streaming, taustaülesandeid ja Webhooks. Kõik variandid kasutavad teksti, keelekoodi ja režiimi.

Lõpppunkt

POST /api/v2/translate

Parim, kui

Väikeid tekste, mille tulemused on kohe vajalikud.

Edu

200 Olgu.

Sorrutus

Vastus kasutab sisutüüpi: text/event-stream.

Lõpppunkt

POST /api/v2/translate/stream

Parim, kui

Pikema sisu jaoks, mille tulemust tuleks kuvada samm-sammult.

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

Sorrame algab metaga, seejärel järgneb üks või mitu teksti osa delta.

Esimene sündmus sisaldab päringu ID-d, keelekoodi ja režiimi.

Iga delta sisaldab osa tulemusest ja tehtud sisaldab kasutusteavet.

Pärast lõpetamist ühendus sulgub.

Asynchronootiv töö valimistega

Idempotency-Key väldib topelttöid, kui saadate päringu pärast ajalõppu või ühenduse viga uuesti. Valige iga uue töö jaoks uus võti, näiteks UUID. Selle päringu identifikaatori loote ise; see ei ole teie API-võti.

Looda lõpppunkt

POST /api/v2/jobs

Status lõpppunkt

GET /api/v2/jobs/{id}

Kasutage 1 kuni 255 märki: A-Z, a-z, 0-9, punkte (.), allkriipse (_), kooloneid (:) või sidekriipse (-). Ärge kasutage tühikuid ega lühendage võtit. Igal korduskatsel saatke sama võti ja sama päringu sisu.

Esimene loomine tagastab HTTP 202. Sama päringu kordamine tagastab HTTP 200 koos olemasoleva töö ID-ga. Sama võti erineva päringuga tagastab HTTP 409. Samad reeglid kehtivad pakktöödele. Allolevad näited sisaldavad päist; asendage iga näidisvõti üks kord iga uue töö või pakktöö jaoks.

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

Tööd on saadaval seitse päeva.

Töö läbib olekud queued, processing, completed või failed. Nurjunud tööd sisaldavad välja error.code. Loomise ja oleku vastused sisaldavad välja expiresAt.

Kõigepealt küsige seisundist uuesti pärast sekundit. Kui töötlemine kestab, suurendage astmejärgult vahemaa.

Asynchronoo tööga webhookiga

Esmalt looge ja kinnitage veebihaagi lõpp-punkt rakenduses Simple8. Seejärel viidake selle lõpp-punkti ID-le töös.

Looda lõpppunkt

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 saadab Simple8-Signature kujul t=<timestamp>,v1=<signature>. <timestamp> on Unixi ajatempel sekundites. Allkiri on <timestamp>.<raw request body> põhjal arvutatud HMAC SHA-256 väiketähtedega kuueteistkümnendväljund.

Kontrolli allkirja muutmata taotluse suhtes. Näete salajast allkirjastamisvõtit üks kord lõpp-punkti loomisel.

Tagastage HTTP 200 või 201 kohe, kui teie süsteem on sündmuse vastu võtnud.

Korduvad: kui viga on, siis proovige seitse päeva jooksul kuni 50 korda uuesti. Viimane katse näete rakenduses.

Kaksikündmused: töödelda iga sündmuse ID ainult üks kord, sest korduv võib saada sama sündmust uuesti.

Partii töötlemine

Saatke 1 kuni 50 üksust maksimaalselt 25 000 tähemärgiga.

Looda lõpppunkt

POST /api/v2/batches

Status lõpppunkt

GET /api/v2/batches/{id}

Iga üksus kasutab sünkroonse päringuna samu teksti-, lokaadi- ja režiimivälju.

Valige edastamiseks küsitlus või kinnitatud veebihaagi lõpp-punkt ja saatke kordumatu Idempotency-Key päis.

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

Paki loomine tagastab esimesel korral HTTP 202 ja idempotentsel kordusel HTTP 200. Webhooki sündmused on job.completed, job.failed, batch.completed ja batch.failed. Lõpetatud webhookide payloadid sisaldavad ainult identifikaatoreid ja olekut. Väljundi lugemiseks kutsuge töö või paki oleku endpointi.

Sellel lehel

Vali, kuidas teie süsteem saab tulemust.

Alustage Simple8 tasuta kasutamist.