Yhdistä uudelleen tuntisuunnitelmaan
API-versio 2026-10-affable-towhee
Liittyy uudelleen vielä luotavan suunnitelman edistymisvirtaan. Valmis suunnitelma vastaa yhdellä result-tapahtumalla. Vielä luotava suunnitelma, jolla ei ole aktiivista virtaa liityttäväksi, vastaa yhdellä pending-tapahtumalla; kysele osoitetta GET /v1/lesson-plans/{id} säännöllisesti, kunnes se on valmis.
Oikeuslaajuudet lesson_plans:read
Parametrit
Lingara-Versionheaderstringvalinnainen- API-versio, jolla tähän pyyntöön vastataan. Ilman sitä käyttötunnus saa version, johon sen asiakas on kiinnitetty, ja pyyntö ilman tunnusta saa nykyisen version. Vielä kehitteillä olevaan versioon pääsee vain nimeämällä sen tässä. Tuntemattomaan versioon vastataan
400koodillaapi_version_unknown.GET /v1/versionsluettelee versiot. idpathstringpakollinen
Vastaukset
200 Suunnitelman jäljellä oleva edistyminen, sitten suunnitelma
Virran tapahtumat text/event-stream
Lähettää keepalive-kommentin 15 sekunnin välein.
-
startedPlanStarted -
plan_idstringpakollinen
-
phasePlanPhase -
phasestringpakollinenattemptintegerpakollinen
-
resultPlanResult Päättää virran -
planLessonPlanpakollinenidstringpakollinenstatusPlanStatuspakollinentitlestring | nullvalinnainensource_langstringpakollinentarget_langstringpakollinenlevelintegerpakollinencreated_atstringpakollinencompleted_atstring | nullvalinnainenai_generatedbooleanpakollinencontentLessonPlanContent | nullvalinnainenintroductionstring | nullvalinnainenlearning_objectivesarray of stringpakollinenvocabularyarray of PlanWordpakollinenwordstringpakollinenpronunciationstring | nullvalinnainentranslationstringpakollinen
setsarray of PlanSetpakollinennumberintegerpakollinencontextstring | nullvalinnainenquestionsarray of PlanQuestionpakollinentypestringpakollinenpromptstringpakollinenoptionsarray of string | nullvalinnainenanswerstringpakollinenexplanationstringpakollinenhintstring | nullvalinnainen
-
pendingPlanPending Päättää virran -
plan_idstringpakollinenstatusPlanStatuspakollinen
-
errorStreamError Päättää virran -
Saapuu 200-vastauksen sisällä. Tilarivi on jo lähetetty, joten virran avaamisen jälkeinen virhe ilmoitetaan tänä tapahtumana.
codestringpakollinenmessagestringpakollinenplan_idstring | nullvalinnainen
Virheet
410application/json- API-versio, jolla tähän pyyntöön vastataan, on lopetettu. Lähetä tuettu versio
Lingara-Version-otsakkeessa tai kiinnitä asiakas toiseen versioon. 4XXapplication/json- Pyyntö hylättiin.
codekertoo syyn, jaerrorkertoo sen sanoin. 503application/json · text/plain- Palvelu ei ole tilapäisesti käytettävissä; yritä uudelleen
Retry-After-otsakkeen ilmoittaman sekuntimäärän jälkeen. Huoltokatkon aikana runko on pelkkää tekstiä virhekehyksen sijaan. 5XXapplication/json- Pyyntö hylättiin.
codekertoo syyn, jaerrorkertoo sen sanoin.
codestringpakollinenMiksi pyyntö hylättiin, pysyvänä koodina, jonka mukaan voit haarautua: esimerkiksi
insufficient_scope(403),rate_limited(429) ja käytön mukaan laskutettavalle asiakkaallespend_cap_reached(402) jametered_billing_inactive(402).errorstringpakollinen
Esimerkki
Käytätkö mieluummin kirjastoa? Katso Kirjastot-osio.
Esimerkkivirta
event: pending
data: {"plan_id":"3f1c2a9e-5b7d-4e21-9a0c-6d8e4f2b1a37","status":"generating"}Jos käännös ja englanninkielinen viite poikkeavat toisistaan, englanninkielinen viite on oikea.