Dokumentazzjoni

Agħżel kif is- sistema tiegħek tirċievi r- riżultat.

{
  "text": "Kontenut sors kumpless fil-lingwa magħżula.",
  "locale": "mt",
  "mode": "simple-language"
}

Eżempji SDK u cURL disponibbli

HTTP sinkroniku

Kull mudell juża l-istess oqsma ewlenin: test, lokali, u mod.

Il-punt finali

POST /api/v2/translate

L-aħjar għal

Kontenut qasir u azzjonijiet diretti ta' backend.

Suċċess

200 OK

Streaming

Ir-rispons juża Content-Type: test/event-stream.

Il-punt finali

POST /api/v2/translate/stream

L-aħjar għal

Interfaċċi progressivi u kontenut itwal.

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

Il-fluss jarmi avveniment meta wieħed, avveniment wieħed jew aktar delta, u avveniment finali magħmul.

Il-meta avveniment fih l-identifikatur tat-talba, il-lokal, u l-mod.

Kull delta fih parti mir-riżultat, u magħmul fih l-informazzjoni dwar l-użu.

Wara li jsir, il-konnessjoni tagħlaq.

Xogħol mhux sinkronizzat mal-votazzjoni

Ibgħat header uniku Idempotency-Key meta toħloq impjieg.

Iġġib punt finali

POST /api/v2/jobs

L-istadju finali tal-istat

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

{
  "jobId": "job_poll_001",
  "status": "completed",
  "locale": "fr",
  "mode": "simple-language",
  "output": {
    "text": "Simplified content in French."
  }
}

L-impjiegi jibqgħu disponibbli għal sebat ijiem.

Istħarriġ f'intervall raġonevoli sakemm l-istatus jitlesta jew falla.

Xogħol async ma ' webhook

Oħloq u vverifika endpoint tal-webhook l-ewwel fl-applikazzjoni Simple8. Imbagħad irreferi l-ID tal-endpoint tagħha fix-xogħol.

Iġġib punt finali

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 jibgħat header Simple8-Signature b'timestamp u firma HMAC SHA-256.

Ivverifika l-firma kontra l-korp tat-talba mhux maħdum bis-sigriet tal-iffirmar muri darba meta jinħoloq l-endpoint.

Irritorna kwalunkwe status 2xx wara li taċċetta l-avveniment.

Kunsinni falluti jerġgħu jiġu ppruvati sa 50 darba fuq sebat ijiem, u tentattivi riċenti huma viżibbli fl-applikazzjoni.

Ir-riċevituri jridu jittolleraw konsenja duplikata minħabba li tentattivi mill-ġdid jistgħu jwasslu l-istess avveniment aktar minn darba.

Ipproċessar tal-lott

Ibgħat bejn 1 u 50 oġġett b'massimu magħqud ta' 500,000 karattru.

Iġġib punt finali

POST /api/v2/batches

L-istadju finali tal-istat

GET /api/v2/batches/{id}

Kull oġġett juża l-istess oqsma tat-test, lokali, u mod bħala talba sinkronika.

Agħżel il-votazzjoni jew endpoint tal-webhook verifikat għall-kunsinna u ibgħat header uniku Idempotency-Key.

F’din il-paġna