Een lesplan maken
API-versie 2026-10-affable-towhee
Begint met het genereren van een lesplan en streamt de voortgang. started noemt het plan zodra het bestaat, zodat een verbroken verbinding opnieuw kan verbinden met GET /v1/lesson-plans/{id}/stream. De stream eindigt met result of error. Een plan uit de bibliotheek komt binnen als één enkel result.
Bevoegdheden lesson_plans:write
Parameters
Lingara-Versionheaderstringoptioneel- De API-versie waaronder dit verzoek wordt beantwoord. Zonder deze krijgt een toegangstoken de versie waaraan zijn client is gekoppeld, en een verzoek zonder token de huidige versie. De versie die nog in ontwikkeling is, bereik je alleen door die hier te noemen. Een onbekende versie geeft
400met codeapi_version_unknown.GET /v1/versionstoont de versies.
Request-body application/json
contextstringverplichtsource_langstringverplichttarget_langstringverplichtlevelintegerverplicht
Antwoorden
200 De voortgang van het plan, daarna het plan
Stream-events text/event-stream
Stuurt elke 15 seconden een keepalive-commentaar.
-
startedPlanStarted -
plan_idstringverplicht
-
phasePlanPhase -
phasestringverplichtattemptintegerverplicht
-
resultPlanResult Beëindigt de stream -
planLessonPlanverplichtidstringverplichtstatusPlanStatusverplichttitlestring | nulloptioneelsource_langstringverplichttarget_langstringverplichtlevelintegerverplichtcreated_atstringverplichtcompleted_atstring | nulloptioneelai_generatedbooleanverplichtcontentLessonPlanContent | nulloptioneelintroductionstring | nulloptioneellearning_objectivesarray of stringverplichtvocabularyarray of PlanWordverplichtwordstringverplichtpronunciationstring | nulloptioneeltranslationstringverplicht
setsarray of PlanSetverplichtnumberintegerverplichtcontextstring | nulloptioneelquestionsarray of PlanQuestionverplichttypestringverplichtpromptstringverplichtoptionsarray of string | nulloptioneelanswerstringverplichtexplanationstringverplichthintstring | nulloptioneel
-
errorStreamError Beëindigt de stream -
Komt binnen het 200-antwoord aan. De statusregel is al verzonden, dus een fout nadat de stream is geopend wordt als deze gebeurtenis gemeld.
codestringverplichtmessagestringverplichtplan_idstring | nulloptioneel
Fouten
402application/json- De aanroep van een client met verbruiksafrekening is geweigerd voordat die iets heeft uitgegeven.
spend_cap_reached: de client of zijn account heeft zijn maandelijkse uitgavenlimiet bereikt; verhoog de limiet op de pagina Integraties.metered_billing_inactive: verbruiksafrekening is niet actief voor dit account; stel die in of werk de betaalmethode bij op de pagina Integraties. 410application/json- De API-versie waaronder dit verzoek wordt beantwoord, is stopgezet. Stuur een ondersteunde versie mee in
Lingara-Version, of koppel de client aan een andere versie. 4XXapplication/json- Het verzoek is geweigerd.
codegeeft de reden aan enerrorbeschrijft die in woorden. 503application/json · text/plain- De dienst is tijdelijk niet beschikbaar; probeer het opnieuw na het aantal seconden in
Retry-After. Tijdens onderhoud is de body platte tekst in plaats van de foutenvelop. 5XXapplication/json- Het verzoek is geweigerd.
codegeeft de reden aan enerrorbeschrijft die in woorden.
codestringverplichtWaarom het verzoek is geweigerd, als stabiele code om op te vertakken: bijvoorbeeld
insufficient_scope(403),rate_limited(429) en, voor een client met verbruiksafrekening,spend_cap_reached(402) enmetered_billing_inactive(402).errorstringverplicht
Voorbeeld
Liever een bibliotheek? Zie de sectie Bibliotheken.
Voorbeeldstream
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."}]}]}}}Als een vertaling afwijkt van de Engelse referentie, is de Engelse referentie juist.