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

Qabbel tweġibiet diretti, streaming, impjiegi fl-isfond, u webhooks. Il-varjanti kollha jużaw test, kodiċi tal-lingwa u l-mod.

Il-punt finali

POST /api/v2/translate

L-aħjar għal

Testi qosra, li r-riżultat tagħhom huwa meħtieġ immedjatament.

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

Għal kontenut ikbar, li r-riżultat tiegħu għandu jidher b'pass pass.

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

Il-fluss jibda bil-meta. Dan huwa segwit minn parti waħda jew aktar tat-test bħala delta. L-avveniment magħmul tikkompleta r-rispons bid-dejta użu.

L-ewwel avveniment fih l-ID tal-mistoqsija, il-kodiċi tal-lingwa u l-modalità.

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. Għal tentattivi mill-ġdid uża l-istess ċavetta, mingħajr spazji fil-bidu jew fit-tmiem, b'tul ta' bejn 1 u 255 karattru. L-ewwel ħolqien jirritorna 202, filwaqt li ripetizzjoni tirritorna 200.

Iġġib punt finali

POST /api/v2/jobs

L-istadju finali tal-istat

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

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

Biċċa xogħol tgħaddi mill-istati queued, processing, completed jew failed. Xogħlijiet li jfallu jinkludu error.code. It-tweġibiet tal-ħolqien u tal-istatus jinkludu expiresAt.

L-ewwel jistaqsu għall-istatus mill-ġdid wara sekonda. Żieda fid-distanza gradwalment ma 'ipproċessar itwal.

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

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 tibgħat Simple8-Signature bħala t=<timestamp>,v1=<signature>. <timestamp> huwa marka tal-ħin Unix f'sekondi. Il-firma hija r-riżultat eżadeċimali b'ittri żgħar ta' HMAC SHA-256 fuq <timestamp>.<raw request body>.

Iċċekkja s-sinjal ibbażat fuq it-talba mhux mibdula. Tistgħu taraw il-muftieħ sigriet tas-sinjal darba waħda meta toħloq il-punt tat-tmiem.

Irritorna HTTP 200 jew 201 hekk kif is-sistema tiegħek taċċetta l-avveniment.

Ripeti: Fil-każ ta 'żball, tentattivi Simple8 sa 50 darbiet fi żmien sebat ijiem. Tista 'tara l-aħħar tentattivi fl-applikazzjoni.

Avvenimenti duplikati: Proċess kull ID avveniment darba biss, bħala ripetizzjoni tista 'tirrispondi l-istess avveniment.

Ipproċessar tal-lott

Ibgħat bejn 1 u 50 oġġett b'massimu magħqud ta' 25,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.

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

Il-ħolqien ta' batch jirritorna HTTP 202 l-ewwel darba u HTTP 200 għal ripetizzjoni idempotenti. L-avvenimenti webhook huma job.completed, job.failed, batch.completed u batch.failed. Il-payloads ta' webhooks kompluti fihom biss identifikaturi u status. Ikseb l-output mill-endpoint tal-istatus tax-xogħol jew tal-batch.

Ibda uża Simple8 b'xejn.

Oħloq il-kont tiegħek b'xejn u uża sa 15,000 karattru b'xejn kull xahar.