Lingara API संदर्भ

API संस्करण 2026-10-affable-towhee

Lingara द्वारा सिखाई जाने वाली भाषाओं में शब्दावली सूचियाँ और पाठ योजनाएँ बनाएँ, और ट्यूटर से बातचीत करें। हर कॉल का भुगतान वह क्लाइंट करता है जो उसे करता है: एक allowance क्लाइंट अपने मालिक का भत्ता खर्च करता है, और एक metered क्लाइंट से उसके उपयोग का बिल लिया जाता है।

लाइब्रेरी पसंद है? लाइब्रेरी अनुभाग देखें।

बेस URL https://api.getlingara.com

एक OAuth 2.0 एक्सेस टोकन, जो Authorization: Bearer <token> के रूप में भेजा जाता है। स्वयं की ओर से काम करने वाला सर्वर टोकन URL पर अपने क्लाइंट की id और सीक्रेट एक्सचेंज करता है (client_credentials)। सहमति देने वाले किसी Lingara उपयोगकर्ता की ओर से काम करने वाला ऐप ऑथराइज़ेशन कोड (authorization_code) का उपयोग करता है और फिर टोकन रिफ़्रेश करता है। एक टोकन एक घंटे तक चलता है। हर ऑपरेशन को एक स्कोप चाहिए।

टोकन URL https://api.getlingara.com/oauth/token

स्कोप
`vocab:generate`	शब्दावली सूचियाँ बनाएँ।	शब्दावली सूची बनाएँ
`lesson_plans:read`	अपनी पाठ योजनाएँ पढ़ें और उनकी प्रगति से दोबारा जुड़ें।	पाठ योजना प्राप्त करें पाठ योजना से दोबारा जुड़ें
`lesson_plans:write`	पाठ योजनाएँ बनाएँ।	पाठ योजना बनाएँ
`tutor:converse`	ट्यूटर से बातचीत करें। सशुल्क प्लान आवश्यक है।	ट्यूटर को एक बारी भेजें
`usage:read`	अपना बचा हुआ भत्ता देखें, या किसी `metered` क्लाइंट का इस महीने का उपयोग।	अपना बचा हुआ भत्ता प्राप्त करें
`events:read`	अपने खाते के बारे में इवेंट पढ़ें, और उन्हें प्राप्त करने वाले एंडपॉइंट पंजीकृत करें।	घटनाओं की सूची घटनाओं की स्ट्रीम
`events:write`	अपने गेम या इंटीग्रेशन से Lingara को इवेंट भेजें।	घटना भेजें

त्रुटियाँ

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आवश्यक

शब्दावली

शिक्षार्थी के स्तर पर शब्दावली सूचियाँ बनाएँ।

शब्दावली सूची बनाएँ POST /v1/vocab/stream

पाठ योजनाएँ

पाठ योजनाएँ बनाएँ, उन्हें पढ़ें, और ऐसी योजना से दोबारा जुड़ें जो अभी बन रही है।

पाठ योजना बनाएँ POST /v1/lesson-plans
पाठ योजना प्राप्त करें GET /v1/lesson-plans/{id}
पाठ योजना से दोबारा जुड़ें GET /v1/lesson-plans/{id}/stream

ट्यूटर

भाषा ट्यूटर से एक-एक बारी करके बातचीत करें।

ट्यूटर को एक बारी भेजें POST /v1/tutor/message

घटनाएँ

अपने खाते में होने वाली घटनाएँ पढ़ें, पेज दर पेज या स्ट्रीम के रूप में।

घटनाओं की सूची GET /v1/events
घटना भेजें POST /v1/events
घटनाओं की स्ट्रीम GET /v1/events/stream

खाता

देखें कि आपका कितना भत्ता बचा है।

अपना बचा हुआ भत्ता प्राप्त करें GET /v1/usage

संदर्भ

यह दस्तावेज़, मशीन-पठनीय रूप में।

यह दस्तावेज़ प्राप्त करें GET /v1/openapi.json
इवेंट दस्तावेज़ प्राप्त करें GET /v1/asyncapi.json
API संस्करणों की सूची GET /v1/versions
एक API संस्करण पाएँ GET /v1/versions/{id}

इवेंट सूची

Lingara आपके खाते की पाठ योजनाओं और उपयोग के साथ जो कुछ होता है, उसे इवेंट के रूप में दर्ज करता है, और आपके गेम या ऐप से इवेंट स्वीकार करता है। हर इवेंट का, चाहे वह किसी भी रास्ते से जाए, एनवेलप एक जैसा होता है, और इवेंट सूची उन सभी को सूचीबद्ध करती है। वेबहुक और इवेंट

Lingara → आप lesson_plan.ready
Lingara → आप lesson_plan.failed
Lingara → आप usage.threshold_reached
Lingara → आप webhook.test
Lingara → आप app.installed
Lingara → आप app.uninstalled

आप → Lingara world.context_changed
आप → Lingara world.practice_requested

यदि किसी अनुवाद और अंग्रेज़ी संदर्भ में अंतर हो, तो अंग्रेज़ी संदर्भ ही मान्य है।