د درس پلان جوړول
د API نسخه 2026-10-affable-towhee
د درس پلان جوړول پیلوي او پرمختګ یې د جریان په ډول لېږي. started پلان هماغه وخت نوموي چې جوړ شي، څو یو پرې شوی اتصال وکولای شي د GET /v1/lesson-plans/{id}/stream له لارې بیا وصل شي. جریان په result یا error پای ته رسېږي. هغه پلان چې له کتابتون څخه وړاندې کېږي، د یوه یوازیني result په توګه رسېږي.
ساحې lesson_plans:write
پیرامیټرونه
Lingara-Versionheaderstringاختیاري- د API هغه نسخه چې دې غوښتنې ته پرې ځواب ورکول کېږي. له دې پرته، لاسرسي ټوکن هغه نسخه ترلاسه کوي چې د هغه کلاینټ ورسره تړل شوی، او بې ټوکنه غوښتنه اوسنۍ نسخه ترلاسه کوي. هغې نسخې ته چې لا هم د پراختیا په حال کې ده یوازې دلته د هغې په نومولو رسېدای شئ. نامعلومې نسخې ته د
400او کوډapi_version_unknownسره ځواب ورکول کېږي.GET /v1/versionsنسخې لېست کوي.
د غوښتنې بدنه application/json
contextstringاړینsource_langstringاړینtarget_langstringاړینlevelintegerاړین
ځوابونه
200 د پلان پرمختګ، بیا پخپله پلان
د جریان پېښې text/event-stream
هرو 15 ثانیو کې یوه keepalive تبصره لېږي.
-
startedPlanStarted -
plan_idstringاړین
-
phasePlanPhase -
phasestringاړینattemptintegerاړین
-
resultPlanResult جریان پای ته رسوي -
planLessonPlanاړینidstringاړینstatusPlanStatusاړینtitlestring | nullاختیاريsource_langstringاړینtarget_langstringاړینlevelintegerاړینcreated_atstringاړینcompleted_atstring | nullاختیاريai_generatedbooleanاړینcontentLessonPlanContent | nullاختیاريintroductionstring | nullاختیاريlearning_objectivesarray of stringاړینvocabularyarray of PlanWordاړینwordstringاړینpronunciationstring | nullاختیاريtranslationstringاړین
setsarray of PlanSetاړینnumberintegerاړینcontextstring | nullاختیاريquestionsarray of PlanQuestionاړینtypestringاړینpromptstringاړینoptionsarray of string | nullاختیاريanswerstringاړینexplanationstringاړینhintstring | nullاختیاري
-
errorStreamError جریان پای ته رسوي -
د 200 ځواب دننه رارسېږي. د حالت کرښه دمخه لېږل شوې ده، نو د جریان له پرانیستو وروسته هره ناکامي د دې پېښې په توګه راپور کېږي.
codestringاړینmessagestringاړینplan_idstring | nullاختیاري
تېروتنې
402application/json- د کارونې له مخې بیل کېدونکي پېرودونکي غوښتنه مخکې له دې چې څه ولګوي رد شوه.
spend_cap_reached: پېرودونکی یا د هغه حساب خپلې میاشتنۍ لګښت پولې ته رسېدلی؛ پوله د یوځای کېدنو په پاڼه کې لوړه کړئ.metered_billing_inactive: د دې حساب لپاره د کارونې له مخې بیل فعال نه دی؛ هغه د یوځای کېدنو په پاڼه کې تنظیم کړئ یا د تادیې طریقه تازه کړئ. 410application/json- د API هغه نسخه چې دې غوښتنې ته پرې ځواب ورکول کېږي بنده شوې ده. په
Lingara-Versionکې یوه ملاتړ شوې نسخه ولېږئ، یا کلاینټ له بلې نسخې سره وتړئ. 4XXapplication/json- غوښتنه رد شوه.
codeلامل ښیي، اوerrorیې په کلمو بیانوي. 503application/json · text/plain- خدمت په لنډمهاله توګه نه شته؛ د هغو ثانیو له تېرېدو وروسته بیا هڅه وکړئ چې په
Retry-Afterکې راغلي دي. د ساتنې پر مهال، د ځواب بدنه د تېروتنې د پاکټ پر ځای ساده متن وي. 5XXapplication/json- غوښتنه رد شوه.
codeلامل ښیي، اوerrorیې په کلمو بیانوي.
codestringاړینولې غوښتنه رد شوه، د یو ثابت کوډ په توګه چې پر بنسټ یې پرېکړه کولی شئ: د بېلګې په توګه
insufficient_scope(403)،rate_limited(429) او، د کارونې له مخې بیل کېدونکي پېرودونکي لپاره،spend_cap_reached(402) اوmetered_billing_inactive(402).errorstringاړین
بېلګه
کتابتون غوره بولئ؟ د کتابتونونو برخه وګورئ.
د جریان بېلګه
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."}]}]}}}که یوه ژباړه له انګلیسي مرجع سره توپیر ولري، انګلیسي مرجع سمه ده.