profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchAdminipaneeli puhverserveri seadistamineCEL Scripting in Template BuilderProject ScaffoldingMedia Library

Headless

KiirkäivitusSplit Screen JSON Component Builder with LLMComponent Zod Pull

RESTi API

REST API OverviewgetConnect your websitegetMarsruutide hankiminegetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPOST /translationpatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

POST /translation

Käivita skeemi avaldatud dokumentide hulgitõlkimine taustal sihtkeeltesse.

Kõigi avaldatud dokumentide taustal tõlkimise järjekorda lisamine ühest või mitmest komponendiskeemist sihtkeelte komplekti. Tulemused lisatakse või uuendatakse tabelis translations iga tõlke valmimisel.

Lõpp-punkt: POST /translation Autentimine: Bearer JWT (WorkOS)

Päringu keha

{
  "websiteId": "<uuid>",
  "schemaNames": ["post", "hero"],
  "languages": ["fr", "es", "de"]
}
VäliTüüpKohustuslikMärkused
websiteIduuidjahVeebisait, mis sisaldab lähtedokumente.
schemaNamesstring[]jah*Tõlgitavad komponendiskeemid. Korduvad nimed eemaldatakse.
schemaNamestringjah*Pärandtugi ühe skeemi esitamiseks.
languagesstring[]jahToetatud sihtkeelte koodid. Korduvad koodid eemaldatakse.

* Esitage kas schemaNames või schemaName.

Arvesse võetakse ainult avaldatud dokumente, mille avaldatud sisu ei ole null.

Vastus

{
  "job_id": "<uuid>",
  "website_id": "<uuid>",
  "schema_name": null,
  "schema_names": ["post", "hero"],
  "languages": ["fr", "es", "de"],
  "status": "queued",
  "documents_processed": 12,
  "translations_scheduled": 30,
  "translations_skipped": 6,
  "translations_completed": 0,
  "translations_failed": 0,
  "reused": false,
  "created_at": "2026-07-15T18:00:00Z",
  "updated_at": "2026-07-15T18:00:00Z"
}

Tagastatakse:

  • 202 Accepted, kui tõlked lisatakse järjekorda
  • 200 OK, kui kõik tõlked on juba ajakohased
  • olemasolev aktiivne töö, kui identne päring on juba käimas
VäliKirjeldus
job_idTöö edenemise hankimiseks kasutatav identifikaator.
statusTöö hetkeseisund.
documents_processedLeitud sobilike lähtedokumentide arv.
translations_scheduledJärjekorda lisatud dokumendi-keele paaride arv.
translations_skippedVahele jäetud tõlgete arv, kuna nende lähte-räsi on ajakohane.
translations_completedEdukalt tõlgitud tõlgete arv.
translations_failedNurjunud tõlgete arv.
reusedKas vastus viitab olemasolevale aktiivsele tööle.

Võimalikud töö olekud on:

  • preparing — ettevalmistamine
  • queued — järjekorras
  • running — käimas
  • completed — lõpetatud
  • completed_with_errors — lõpetatud vigadega
  • failed — nurjunud

Ajakohaste tõlgete vahelejätmine

Iga dokumendi-keele paar salvestab lähtedokumendi avaldatud sisu SHA-256 räsi.

Tõlge jäetakse vahele, kui selle salvestatud lähte-räsi vastab praegusele avaldatud sisule. See võimaldab lõpp-punkti korduvalt kutsuda, ilma muutmata sisu uuesti tõlkimata.

Kui avaldatud sisu muutub samaväärse töö aktiivsena oleku ajal, lükkab teenus uue päringu tagasi. Esitage päring uuesti pärast aktiivse töö lõpetamist.

Töötlemise käitumine

Tõlkimine toimub pärast esialgset vastust asünkroonselt.

  • Tööd töödeldakse piiratud samaaegsusega.
  • Ajutisi tõrkeid proovitakse uuesti tagasipöördumisega.
  • Edukad tulemused püsitatakse nende valmimisel.
  • Üksikud järeldus- või püsivustõrked salvestatakse töö juurde.
  • Osaliselt edukas töö lõpetatakse olekuga completed_with_errors.

Näide

curl -X POST '{TRANSLATION_API_URL}/translation' \
  -H 'Authorization: Bearer <workos-jwt>' \
  -H 'Content-Type: application/json' \
  -d '{
    "websiteId": "<uuid>",
    "schemaNames": ["post", "hero"],
    "languages": ["fr", "es"]
  }'

Tõrked

  • 400 Bad Request — skeemid või keeled puuduvad, keel ei ole toetatud või pakk ületab seadistatud limiidi
  • 401 Unauthorized — bearer-märk puudub või on kehtetu
  • 409 Conflict — vastav töö on aktiivne, kuid avaldatud lähte­sisu muutus
  • 500 Internal Server Error — lähtedokumente ei saanud ette valmistada või andmebaasitoiming nurjus

Tõlketöö hankimine

Hankige tõlketöö uusim edenemine.

Lõpp-punkt: GET /translation-jobs/{job_id} Autentimine: Bearer JWT (WorkOS)

Vastus

Vastus kasutab sama tööobjekti, mille tagastab POST /translation, kuid oleku ja edenemise loendurid on uuendatud.

{
  "job_id": "<uuid>",
  "website_id": "<uuid>",
  "schema_name": null,
  "schema_names": ["post", "hero"],
  "languages": ["fr", "es"],
  "status": "running",
  "documents_processed": 12,
  "translations_scheduled": 24,
  "translations_skipped": 0,
  "translations_completed": 16,
  "translations_failed": 1,
  "reused": false,
  "created_at": "2026-07-15T18:00:00Z",
  "updated_at": "2026-07-15T18:01:30Z"
}

Näide

curl '{TRANSLATION_API_URL}/translation-jobs/<job-id>' \
  -H 'Authorization: Bearer <workos-jwt>'

Tõrked

  • 401 Unauthorized — bearer-märk puudub või on kehtetu
  • 404 Not Found — tööd ei ole olemas või seda ei säilitata enam

Tõlketöid säilitatakse praegu mälus. Töö olek kaob tõlketeenuse taaskäivitamisel ning mitme eksemplariga juurutused nõuavad kleepuvat marsruutimist.

Continue Reading
Previous‹PATCH /dataset/{schema_name}NextPATCH /translations›