Dokumentacija

Pasirinkite, kaip jūsų sistema gauna rezultatą.

{
  "text": "Sudėtingas šaltinio turinys pasirinkta kalba.",
  "locale": "lt",
  "mode": "simple-language"
}

Galimi SDK ir cURL pavyzdžiai

Sinkroninis HTTP

Palyginkite tiesioginius atsakymus, srautinį duomenų perdavimą, foninius darbus ir kabliukus. Visi variantai naudoja tekstą, kalbos kodą ir režimą.

Baigiamasis punktas

POST /api/v2/translate

Geriausia

Trumpi tekstai, kurių rezultatai yra reikalingi nedelsiant.

Išvykimas

200 Gerai

Stereo

Atsakyme naudojamas turinio tipas: tekstas / įvykio srautas.

Baigiamasis punktas

POST /api/v2/translate/stream

Geriausia

Ilgesnio turinio, kurio rezultatas turėtų būti rodomas palaipsniui.

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

Srautas prasideda meta. Po to viena ar kelios teksto dalys laikomos delta koeficientu. Atliktas įvykis užbaigia atsakymą su naudojimo duomenimis.

Pirmajame renginyje yra užklausos ID, balso kodas ir režimas.

Kiekviename delta yra dalis rezultato, o padaryta yra naudojimo informacija.

Atlikus ryšį, ryšys nutraukiamas.

Asinkronizuotas darbas su apklausais

Kurdami darbą nusiųskite unikalią Idempotency-Key antraštę. Kartodami užklausą naudokite tą patį 1-255 ženklų raktą be tarpų pradžioje ir pabaigoje. Pirmasis sukūrimas grąžina 202, o pakartotinė užklausa grąžina 200.

Sukurti galutinį tašką

POST /api/v2/jobs

Statuso galutinis taškas

GET /api/v2/jobs/{id}

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

Darbo vietos išlieka septynias dienas.

Užduoties būsena keičiasi į queued, processing, completed arba failed. Nepavykusiose užduotyse pateikiamas error.code. Sukūrimo ir būsenos atsakymuose pateikiamas expiresAt.

Pirma paprašyti statuso dar kartą po vienos sekundės. Palaipsniui didinti atstumą su ilgesniu apdorojimu.

Asinkronizuotas darbas su "webhook"

Pirmiausia sukurkite ir patikrinkite „Webhook“ galinį tašką Simple8 programoje. Tada nurodykite jo galinio taško ID užduotyje.

Sukurti galutinį tašką

POST /api/v2/jobs

{
  "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 siunčia Simple8-Signature formatu t=<timestamp>,v1=<signature>. <timestamp> yra Unix laiko žyma sekundėmis. Parašas yra mažosiomis raidėmis užrašyta šešioliktainė <timestamp>.<raw request body> HMAC SHA-256 išvestis.

Patikrinkite parašą pagal nepakeistą prašymą. Jūs pamatysite slaptą parašo raktą, kai jūs sukurti tikslą.

Kai tik sistema priima įvykį, grąžinkite HTTP 200 arba 201.

Pakartojimai: Jei įvyko klaida, Simple8 bando pristatyti iki 50 kartų per septynias dienas. Galite pamatyti paskutinius bandymus paraiškoje.

Dublikuoti įvykius: apdoroti kiekvieno įvykio ID tik vieną kartą, kaip pakartoti gali atkurti tą patį įvykį.

Paketinis apdorojimas

Siųskite nuo 1 iki 50 elementų, kurių bendras ne daugiau kaip 25 000 simbolių.

Sukurti galutinį tašką

POST /api/v2/batches

Statuso galutinis taškas

GET /api/v2/batches/{id}

Kiekvienas elementas naudoja tuos pačius teksto, lokalės ir režimo laukus kaip sinchroninę užklausą.

Pasirinkite apklausą arba patvirtintą „Webhook“ galinį tašką pristatymui ir atsiųskite unikalią „Idempotency-Key“ antraštę.

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

Pirmą kartą kuriant paketą grąžinamas HTTP 202, o idempotentiškai pakartojus - HTTP 200. Webhook įvykiai yra job.completed, job.failed, batch.completed ir batch.failed. Užbaigtų webhook payloaduose pateikiami tik identifikatoriai ir būsena. Rezultatą gaukite iš užduoties arba paketo būsenos endpointo.

Šiame puslapyje

Pasirinkite, kaip jūsų sistema gauna rezultatą.

Pradėkite naudotis Simple8 nemokamai.