Dokumentace

Vyberte si, jak váš systém dostane výsledek.

{
  "text": "Komplexní zdrojový obsah ve zvoleném jazyce.",
  "locale": "cs",
  "mode": "simple-language"
}

Dostupné příklady SDK a cURL

Synchronní HTTP

Porovnávejte přímé odpovědi, Streaming, zázemí a Webhooks. Všechny varianty používají text, jazyk a režim.

Výsledný bod

POST /api/v2/translate

Nejlepší pro

Krátké texty, jejichž výsledek je okamžitě potřebný.

Úspěch

200 OK

Střímací

Odpověď používá Content-Type: text/event-stream.

Výsledný bod

POST /api/v2/translate/stream

Nejlepší pro

Pro delší obsah, jehož výsledek by se měl zobrazovat krok za krokem.

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

Stream začíná meta, pak následuje jedna nebo více částí textu jako delta. Událost done ukončí odpověď s užitkovými daty.

První událost obsahuje ID požadavku, kód jazyka a režim.

Každá delta obsahuje část výsledku a done obsahuje informace o použití.

Po dokončení se spojení uzavře.

Asynchronizace práce s průzkumy

Idempotency-Key zabraňuje duplicitním úlohám, když požadavek odešlete znovu po vypršení časového limitu nebo chybě připojení. Pro každou novou úlohu zvolte nový klíč, například UUID. Tento identifikátor požadavku vytváříte sami; nejde o váš API klíč.

Vytvořit koncový bod

POST /api/v2/jobs

Status koncového bodu

GET /api/v2/jobs/{id}

Použijte 1 až 255 znaků: A-Z, a-z, 0-9, tečky (.), podtržítka (_), dvojtečky (:) nebo spojovníky (-). Nepoužívejte mezery ani klíč nezkracujte. Při každém opakování odešlete stejný klíč a stejné tělo požadavku.

První vytvoření vrací HTTP 202. Opakování stejného požadavku vrací HTTP 200 s ID existující úlohy. Stejný klíč s jiným požadavkem vrací HTTP 409. Stejná pravidla platí pro dávky. Níže uvedené příklady obsahují hlavičku; každý ukázkový klíč nahraďte jednou pro každou novou úlohu nebo dávku.

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

Úkoly zůstávají k dispozici sedm dní.

Úloha prochází stavy queued, processing, completed nebo failed. Neúspěšné úlohy obsahují error.code. Odpovědi na vytvoření a stav obsahují expiresAt.

Zkuste se zeptat na stav znovu po sekundě. Po dlouhém zpracování postupně zvětšujte vzdálenost.

Asynchronizace s webhookem

Nejprve vytvořte a ověřte koncový bod webhooku v aplikaci Simple8. Potom v úloze odkazujte na jeho ID koncového bodu.

Vytvořit koncový bod

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 odesílá Simple8-Signature ve formátu t=<timestamp>,v1=<signature>. <timestamp> je unixové časové razítko v sekundách. Podpis je výstup HMAC SHA-256 z <timestamp>.<raw request body> zapsaný malými hexadecimálními znaky.

Zkontrolujte podpis oproti nezměněnému požadavku. Tajný podpisový klíč uvidíte jednou při vytváření koncového bodu.

Jakmile váš systém událost přijme, ihned vraťte HTTP 200 nebo 201.

Opakuje se: v případě chyby Simple8 se pokusí o doručení do sedmi dnů až 50krát znovu. Poslední zkoušky můžete vidět v aplikaci.

Dvojitá událost: Zpracujte každý ID události pouze jednou, protože opakování může znovu vyslat stejnou událostí.

Dávkové zpracování

Odešlete 1 až 50 položek s celkovým maximálním počtem 25 000 znaků.

Vytvořit koncový bod

POST /api/v2/batches

Status koncového bodu

GET /api/v2/batches/{id}

Každá položka používá stejný text, národní prostředí a pole režimu jako synchronní požadavek.

Vyberte dotazování nebo ověřený koncový bod webhooku pro doručení a odešlete jedinečnou hlavičku Idempotency-Key.

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

Vytvoření dávky vrátí při prvním volání HTTP 202 a při idempotentním opakování HTTP 200. Webhook události jsou job.completed, job.failed, batch.completed a batch.failed. Payloady dokončených webhooků obsahují pouze identifikátory a stav. Výstup načtete z endpointu stavu úlohy nebo dávky.

Začněte zdarma používat Simple8.

Vytvořte si svůj bezplatný účet a používejte až 15 000 znaků zdarma každý měsíc.