Skep 'n lesplan
API-weergawe 2026-10-affable-towhee
Begin om 'n lesplan te genereer en stroom die vordering daarvan. started noem die plan sodra dit bestaan, sodat 'n verbroke verbinding met GET /v1/lesson-plans/{id}/stream kan herkoppel. Die stroom eindig met result of error. 'n Plan wat uit die biblioteek bedien word, kom as 'n enkele result aan.
Omvange lesson_plans:write
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.
Versoekliggaam application/json
contextstringverpligsource_langstringverpligtarget_langstringverpliglevelintegerverplig
Antwoorde
200 Die plan se 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
-
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
402application/json- 'n Oproep van 'n gemeterde kliënt is geweier voordat dit iets bestee het.
spend_cap_reached: die kliënt of sy rekening het sy maandelikse bestedingslimiet bereik; verhoog die limiet op die Integrasies-bladsy.metered_billing_inactive: gebruiksfakturering is nie aktief vir hierdie rekening nie; stel dit op, of werk die betaalmetode by, op die Integrasies-bladsy. 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: started
data: {"plan_id":"3f1c2a9e-5b7d-4e21-9a0c-6d8e4f2b1a37"}
event: phase
data: {"phase":"selecting_vocabulary","attempt":1}
event: result
data: {"plan":{"id":"3f1c2a9e-5b7d-4e21-9a0c-6d8e4f2b1a37","status":"complete","title":"At the night market","source_lang":"en","target_lang":"zh","level":2,"created_at":"2026-09-23T10:00:00Z","completed_at":"2026-09-23T10:00:41Z","ai_generated":true,"content":{"introduction":"Order food and ask prices at a night market.","learning_objectives":["Ask how much something costs"],"vocabulary":[{"word":"多少钱","pronunciation":"duōshao qián","translation":"how much"}],"sets":[{"number":1,"questions":[{"type":"multiple_choice_word","prompt":"Which word asks for a price?","options":["多少钱","谢谢"],"answer":"多少钱","explanation":"多少钱 means how much money."}]}]}}}Indien 'n vertaling en die Engelse verwysing verskil, is die Engelse verwysing korrek.