Gumawa ng lesson plan
Bersyon ng API 2026-10-affable-towhee
Sinisimulang gawin ang isang lesson plan at ini-stream ang progreso nito. Pinangangalanan ng started ang plan sa sandaling umiral ito, kaya ang naputol na koneksyon ay maaaring muling kumonekta gamit ang GET /v1/lesson-plans/{id}/stream. Nagtatapos ang stream sa result o error. Ang plan na mula sa library ay dumarating bilang iisang result.
Mga scope lesson_plans:write
Mga parameter
Lingara-Versionheaderstringopsyonal- Ang bersyon ng API na gagamitin sa pagsagot sa kahilingang ito. Kung wala ito, makukuha ng access token ang bersyong naka-pin sa client nito, at makukuha ng kahilingang walang token ang kasalukuyang bersyon. Maaabot lang ang bersyong dine-develop pa sa pamamagitan ng pagpangalan dito. Ang hindi kilalang bersyon ay sinasagot ng
400na may code naapi_version_unknown. Inililista ngGET /v1/versionsang mga bersyon.
Katawan ng kahilingan application/json
contextstringkailangansource_langstringkailangantarget_langstringkailanganlevelintegerkailangan
Mga tugon
200 Ang progreso ng plan, pagkatapos ay ang plan
Mga event ng stream text/event-stream
Nagpapadala ng keepalive na komento bawat 15 segundo.
-
startedPlanStarted -
plan_idstringkailangan
-
phasePlanPhase -
phasestringkailanganattemptintegerkailangan
-
resultPlanResult Tinatapos ang stream -
planLessonPlankailanganidstringkailanganstatusPlanStatuskailangantitlestring | nullopsyonalsource_langstringkailangantarget_langstringkailanganlevelintegerkailangancreated_atstringkailangancompleted_atstring | nullopsyonalai_generatedbooleankailangancontentLessonPlanContent | nullopsyonalintroductionstring | nullopsyonallearning_objectivesarray of stringkailanganvocabularyarray of PlanWordkailanganwordstringkailanganpronunciationstring | nullopsyonaltranslationstringkailangan
setsarray of PlanSetkailangannumberintegerkailangancontextstring | nullopsyonalquestionsarray of PlanQuestionkailangantypestringkailanganpromptstringkailanganoptionsarray of string | nullopsyonalanswerstringkailanganexplanationstringkailanganhintstring | nullopsyonal
-
errorStreamError Tinatapos ang stream -
Dumarating sa loob ng 200 na tugon. Naipadala na ang status line, kaya ang pagkabigo matapos mabuksan ang stream ay iniuulat bilang event na ito.
codestringkailanganmessagestringkailanganplan_idstring | nullopsyonal
Mga error
402application/json- Tinanggihan ang tawag ng isang metered client bago ito nakagastos ng anuman.
spend_cap_reached: naabot na ng client o ng account nito ang buwanang limitasyon sa paggastos; itaas ang limitasyon sa pahinang Mga integration.metered_billing_inactive: hindi aktibo ang usage billing para sa account na ito; i-set up ito, o i-update ang paraan ng pagbabayad, sa pahinang Mga integration. 410application/json- Itinigil na ang bersyon ng API na ginagamit sa pagsagot sa kahilingang ito. Magpadala ng suportadong bersyon sa
Lingara-Version, o i-pin ang client sa ibang bersyon. 4XXapplication/json- Tinanggihan ang kahilingan. Sinasabi ng
codekung bakit, at ipinapaliwanag ito ngerrorsa mga salita. 503application/json · text/plain- Pansamantalang hindi available ang serbisyo; subukang muli pagkatapos ng bilang ng segundong nasa
Retry-After. Habang may maintenance, plain text ang body sa halip na ang error envelope. 5XXapplication/json- Tinanggihan ang kahilingan. Sinasabi ng
codekung bakit, at ipinapaliwanag ito ngerrorsa mga salita.
codestringkailanganKung bakit tinanggihan ang request, bilang isang matatag na code na mapagbabatayan ng iyong programa: halimbawa
insufficient_scope(403),rate_limited(429) at, para sa isang metered client,spend_cap_reached(402) atmetered_billing_inactive(402).errorstringkailangan
Halimbawa
Mas gusto ang library? Tingnan ang seksyong Mga library.
Halimbawang stream
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."}]}]}}}Kung magkaiba ang isang salin at ang sangguniang Ingles, ang sangguniang Ingles ang tama.