Dokumentaatio

Valitse, miten järjestelmäsi saa tuloksen.

{
  "text": "Monimutkainen lähdesisältö valitulla kielellä.",
  "locale": "fi",
  "mode": "simple-language"
}

SDK- ja cURL-esimerkkejä saatavilla

Synkroniinen HTTP

Vertaile suoria vastauksia, Streaming, taustatarjouksia ja Webhooks. Kaikki vaihtoehdot käyttävät tekstiä, kieleen koodia ja mallia.

Lopputulos

POST /api/v2/translate

Parasta

Lyhyet tekstit, joiden tulokset ovat välittömästi tarpeen.

Menestys

200 Hyvä on.

Lähetys

Vastaus käyttää Content-Type: text/event-stream.

Lopputulos

POST /api/v2/translate/stream

Parasta

Pidemmälle sisällölle, jonka tulos tulee näyttää askel askeleelta.

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

Aalto alkaa meta-aineella, ja sen jälkeen yksi tai useampi tekstiosa seuraa delta-ainea.

Ensimmäinen tapahtuma sisältää pyyntötunnuksen, kielikoodin ja tilan.

Jokainen delta sisältää osan tuloksesta ja done sisältää käyttötiedot.

Kun olet valmis, yhteys sulkeutuu.

Asynkisointi työllä äänestys

Lähetä yksilöllinen Idempotency-Key-otsikko luodessasi työtä. Käytä uusintayrityksissä samaa välilyönneistä siistittyä 1-255 merkin avainta. Ensimmäinen luonti palauttaa 202 ja uusintapyyntö 200.

Luoda loppupiste

POST /api/v2/jobs

Tilanne päämäärä

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

Työpaikkoja on tarjolla seitsemän päivää.

Työ etenee tilojen queued, processing, completed tai failed kautta. Epäonnistuneet työt sisältävät kentän error.code. Luonti- ja tilavastaukset sisältävät kentän expiresAt.

Kysy tila uudelleen sekunnin kuluttua. Lisäytä etäisyys asteittain pidempään käsittelyyn.

Asynkisointi työ webhookin kanssa

Luo ja vahvista ensin webhook-päätepiste Simple8-sovelluksessa. Viittaa sitten sen päätepisteen tunnukseen työssä.

Luoda loppupiste

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 lähettää Simple8-Signature-arvon muodossa t=<timestamp>,v1=<signature>. <timestamp> on Unix-aikaleima sekunteina. Allekirjoitus on pienillä kirjaimilla kirjoitettu heksadesimaalinen HMAC SHA-256 -tulos arvosta <timestamp>.<raw request body>.

Tarkista allekirjoitus muuttumattomana pyyntöä vastaan. Näet salaisen allekirjoitusavaimen kerran päätepistettä luotaessa.

Palauta HTTP 200 tai 201 heti, kun järjestelmäsi on hyväksynyt tapahtuman.

Toistot: Jos virhe tapahtuu, Simple8 yrittää toimittaa se seitsemän päivän kuluessa jopa 50 kertaa uudelleen.

Kaksi tapahtumaa: Käsittele jokainen tapahtuma-ID vain kerran, koska toisto voi lähettää saman tapahtuman uudelleen.

Eräkäsittely

Lähetä 1–50 kohdetta, joissa on yhteensä enintään 25 000 merkkiä.

Luoda loppupiste

POST /api/v2/batches

Tilanne päämäärä

GET /api/v2/batches/{id}

Jokainen kohde käyttää samoja teksti-, alue- ja tilakenttiä synkronisena pyyntönä.

Valitse kysely tai vahvistettu webhook-päätepiste toimitettavaksi ja lähetä yksilöllinen Idempotency-Key-otsikko.

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

Erän luonti palauttaa ensimmäisellä kerralla HTTP 202:n ja idempotentissa uusinnassa HTTP 200:n. Webhook-tapahtumat ovat job.completed, job.failed, batch.completed ja batch.failed. Valmiiden webhookien payloadit sisältävät vain tunnisteet ja tilan. Nouda tulos työn tai erän tila-endpointista.

Aloita Simple8:n käyttö ilmaiseksi.

Luo ilmainen tili ja käytä jopa 15 000 merkkiä ilmaiseksi joka kuukausi.