Herkoppel aan 'n lesplan
API-weergawe 2026-10-affable-towhee
Sluit weer aan by die vorderingstroom van 'n plan wat nog gegenereer word. 'n Voltooide plan antwoord met een result. 'n Plan wat nog gegenereer word sonder 'n lewendige stroom om by aan te sluit, antwoord met een pending; peil GET /v1/lesson-plans/{id} totdat dit voltooi is.
Omvange lesson_plans:read
Parameters
Lingara-Versionheaderstringopsioneel- Die API-weergawe waaronder hierdie versoek beantwoord word. Daarsonder kry 'n toegangstoken die weergawe waaraan sy kliënt gekoppel is, en 'n versoek sonder 'n token kry die huidige weergawe. Die weergawe wat nog ontwikkel word, is slegs bereikbaar deur dit hier te noem. 'n Onbekende weergawe gee
400met kodeapi_version_unknown.GET /v1/versionslys die weergawes. idpathstringverplig
Antwoorde
200 Die plan se oorblywende vordering, dan die plan
Stroomgebeurtenisse text/event-stream
Stuur elke 15 sekondes 'n keepalive-opmerking.
-
startedPlanStarted -
plan_idstringverplig
-
phasePlanPhase -
phasestringverpligattemptintegerverplig
-
resultPlanResult Beëindig die stroom -
planLessonPlanverpligidstringverpligstatusPlanStatusverpligtitlestring | nullopsioneelsource_langstringverpligtarget_langstringverpliglevelintegerverpligcreated_atstringverpligcompleted_atstring | nullopsioneelai_generatedbooleanverpligcontentLessonPlanContent | nullopsioneelintroductionstring | nullopsioneellearning_objectivesarray of stringverpligvocabularyarray of PlanWordverpligwordstringverpligpronunciationstring | nullopsioneeltranslationstringverplig
setsarray of PlanSetverplignumberintegerverpligcontextstring | nullopsioneelquestionsarray of PlanQuestionverpligtypestringverpligpromptstringverpligoptionsarray of string | nullopsioneelanswerstringverpligexplanationstringverplighintstring | nullopsioneel
-
pendingPlanPending Beëindig die stroom -
plan_idstringverpligstatusPlanStatusverplig
-
errorStreamError Beëindig die stroom -
Kom binne die 200-antwoord aan. Die statusreël is reeds gestuur, so 'n fout nadat die stroom oopgemaak is, word as hierdie gebeurtenis gerapporteer.
codestringverpligmessagestringverpligplan_idstring | nullopsioneel
Foute
410application/json- Die API-weergawe waaronder hierdie versoek beantwoord word, is gestaak. Stuur 'n ondersteunde weergawe in
Lingara-Version, of koppel die kliënt aan 'n ander weergawe. 4XXapplication/json- Die versoek is geweier.
codesê hoekom, enerrorsê dit in woorde. 503application/json · text/plain- Die diens is tydelik onbeskikbaar; probeer weer na die aantal sekondes in
Retry-After. Tydens onderhoud is die liggaam gewone teks eerder as die foutomhulsel. 5XXapplication/json- Die versoek is geweier.
codesê hoekom, enerrorsê dit in woorde.
codestringverpligWaarom die versoek geweier is, as 'n stabiele kode om op te vertak: byvoorbeeld
insufficient_scope(403),rate_limited(429) en, vir 'n gemeterde kliënt,spend_cap_reached(402) enmetered_billing_inactive(402).errorstringverplig
Voorbeeld
Verkies jy 'n biblioteek? Sien die Biblioteke-afdeling.
Voorbeeldstroom
event: pending
data: {"plan_id":"3f1c2a9e-5b7d-4e21-9a0c-6d8e4f2b1a37","status":"generating"}Indien 'n vertaling en die Engelse verwysing verskil, is die Engelse verwysing korrek.