Dokumentācija

Izvēli, kā jūsu sistēma saņem rezultātu.

{
  "text": "Sarežģīts avota saturs atlasītajā valodā.",
  "locale": "lv",
  "mode": "simple-language"
}

Pieejami SDK un cURL piemēri

Sinkrons HTTP

Salīdziniet tiešās atbildes, straumēšanas, fona darbus un webhooks. Visi varianti izmanto tekstu, valodas kodu un režīmu.

Galvenā punkta

POST /api/v2/translate

Labākais

Īsi teksti, kuru rezultāts ir nepieciešams nekavējoties.

Atbalsts

200 OK

Streaming

Atbildē tiek izmantots satura veids: teksts/notikuma straume.

Galvenā punkta

POST /api/v2/translate/stream

Labākais

Ilgākam saturam, kura rezultāts jāizvieto pakāpeniski.

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

Straume sākas ar meta. Tam seko viena vai vairākas teksta daļas kā delta. Paveiktais notikums papildina atbildi ar lietošanas datiem.

Pirmais notikums satur pieprasījuma ID, balss kodu un režīmu.

Katrs delta satur daļu no rezultāta, un veikts satur lietošanas informāciju.

Pēc pabeigšanas savienojums tiek aizvērts.

Asinkronizēts darbs ar aptaujas

Idempotency-Key novērš darbu dublēšanos, ja nosūtāt pieprasījumu vēlreiz pēc noildzes vai savienojuma kļūdas. Katram jaunam darbam izvēlieties jaunu atslēgu, piemēram, UUID. Šo pieprasījuma identifikatoru veidojat pats; tā nav jūsu API atslēga.

Jautājums:

POST /api/v2/jobs

Statusa beigšanas punkts

GET /api/v2/jobs/{id}

Izmantojiet no 1 līdz 255 rakstzīmēm: A-Z, a-z, 0-9, punktus (.), pasvītrojumus (_), kolus (:) vai defises (-). Nelietojiet atstarpes un nesaīsiniet atslēgu. Katrā atkārtotā mēģinājumā nosūtiet to pašu atslēgu un to pašu pieprasījuma saturu.

Pirmā izveide atgriež HTTP 202. Atkārtojot to pašu pieprasījumu, tiek atgriezts HTTP 200 ar esošā darba ID. Tā pati atslēga ar atšķirīgu pieprasījumu atgriež HTTP 409. Tie paši noteikumi attiecas uz paketēm. Tālāk sniegtajos piemēros ir galvene; katru piemēra atslēgu nomainiet vienreiz katram jaunam darbam vai paketei.

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

Darbs ir pieejams septiņas dienas.

Uzdevums pāriet caur stāvokļiem queued, processing, completed vai failed. Neizdevušies uzdevumi ietver error.code. Izveides un statusa atbildes ietver expiresAt.

Vispirms vēlreiz pieprasiet statusu pēc vienas sekundes. Palielināt attālumu pakāpeniski ar ilgāku apstrādi.

Asinkronizācijas darbs ar webhook

Vispirms lietojumprogrammā Simple8 izveidojiet un pārbaudiet tīmekļa aizķeres galapunktu. Pēc tam darbā atsaucieties uz tā galapunkta ID.

Jautājums:

POST /api/v2/jobs

bash
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"
  }
}'
json
{
  "id": "evt_01",
  "type": "job.completed",
  "createdAt": "2026-08-06T12:00:00.000Z",
  "data": {
    "jobId": "job_hook_001",
    "status": "completed"
  }
}

Simple8 nosūta Simple8-Signature formātā t=<timestamp>,v1=<signature>. <timestamp> ir Unix laikspiedols sekundēs. Paraksts ir ar mazajiem burtiem rakstīta heksadecimāla HMAC SHA-256 vērtība, kas aprēķināta no <timestamp>.<raw request body>.

Pārbaudiet parakstu pret nemainīto pieprasījumu. Izveidojot galapunktu, redzēsiet slepenā paraksta atslēgu.

Atgrieziet HTTP 200 vai 201, tiklīdz sistēma pieņem notikumu.

Atkārtojas: Kļūdas gadījumā Simple8 septiņu dienu laikā mēģina piegādāt līdz 50 reizēm. Jūs varat redzēt pēdējos mēģinājumus pieteikumā.

Dublētie notikumi: Apstrādā katra notikuma ID tikai vienu reizi, jo atkārtojums var atkārtoti nosūtīt to pašu notikumu.

Partijas apstrāde

Nosūtiet no 1 līdz 50 vienumiem ar ne vairāk kā 25 000 rakstzīmēm.

Jautājums:

POST /api/v2/batches

Statusa beigšanas punkts

GET /api/v2/batches/{id}

Katrs vienums izmanto tos pašus teksta, lokalizācijas un režīma laukus kā sinhronu pieprasījumu.

Izvēlieties aptauju vai verificētu tīmekļa aizķeres galapunktu piegādei un nosūtiet unikālu Idempotency-Key galveni.

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

Paketes izveide pirmajā reizē atgriež HTTP 202, bet idempotentā atkārtojumā - HTTP 200. Webhook notikumi ir job.completed, job.failed, batch.completed un batch.failed. Pabeigtu webhook payloadi satur tikai identifikatorus un statusu. Lai lasītu rezultātu, pieprasiet uzdevuma vai paketes statusa endpointu.

Sāciet lietot Simple8 bez maksas.

Izveidojiet savu bezmaksas kontu un katru mēnesi izmantojiet līdz 15 000 rakstzīmēm bez maksas.