पाठ योजना बनाएँ
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."}]}]}}}यदि किसी अनुवाद और अंग्रेज़ी संदर्भ में अंतर हो, तो अंग्रेज़ी संदर्भ ही मान्य है।