घटना भेजें

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

post https://api.getlingara.com/v1/events

Lingara को बताता है कि आपके गेम में क्या हुआ, जैसे सीखने वाले का किसी नई जगह में प्रवेश करना। घटना एक बार दर्ज होती है और उसका उत्तर 202 होता है। generate: true के साथ Lingara एक पाठ योजना भी शुरू करता है, जिसके लिए lesson_plans:write चाहिए और जिसकी सीमाएँ और बिलिंग POST /v1/lesson-plans जैसी हैं: reaction योजना का नाम बताता है, और फिर lesson_plan.ready या lesson_plan.failed आता है। दुनिया का वर्णन करें, किसी खिलाड़ी का नाम या चैट कभी नहीं।

स्कोप events:write

पैरामीटर

Lingara-Versionheaderstringवैकल्पिक: वह API संस्करण जिसके अंतर्गत इस अनुरोध का उत्तर दिया जाए। इसके बिना, एक्सेस टोकन को वह संस्करण मिलता है जिससे उसका क्लाइंट जुड़ा है, और बिना टोकन वाले अनुरोध को वर्तमान संस्करण मिलता है। विकासाधीन संस्करण तक केवल उसे यहाँ नाम देकर पहुँचा जा सकता है। अज्ञात संस्करण का उत्तर 400 और कोड api_version_unknown होता है। GET /v1/versions संस्करणों की सूची देता है।
Idempotency-Keyheaderstringआवश्यक: एक मान जिसे आप हर घटना के लिए चुनते हैं और दोबारा कोशिश करते समय फिर से भेजते हैं: 1 से 255 दिखने वाले ASCII वर्ण, जैसे कोई UUID। उसी कुंजी के साथ दोबारा कोशिश करने पर पहला उत्तर वापस मिलता है और दोबारा बिल नहीं होता, भले ही उसकी सामग्री अलग हो। मान्य कुंजी के बिना अनुरोध 400 और कोड idempotency_key_required के साथ उत्तर देता है।

अनुरोध बॉडी `application/json`

typestringआवश्यक

dataWorldPracticeRequestedआवश्यक

topicstringआवश्यक
source_langstringआवश्यक
target_langstringआवश्यक
levelintegerआवश्यक
tagsarray of stringवैकल्पिक
generateboolean | nullवैकल्पिक

प्रतिक्रियाएँ

202 घटना दर्ज हो गई

idstringआवश्यक

typestringआवश्यक

created_atstringआवश्यक

reactionReactionReport | nullवैकल्पिक

statusReactionStatusआवश्यक
plan_idstring | nullवैकल्पिक
plan_statusPlanStatus | nullवैकल्पिक: घटना स्वीकार होने के समय योजना की स्थिति। केवल generating यह वादा करता है कि lesson_plan.ready या lesson_plan.failed आएगा। कोई भी दूसरा मान लाइब्रेरी से दी गई योजना है, जिसे आप अभी GET /v1/lesson-plans/{id} से पढ़ सकते हैं।
codestring | nullवैकल्पिक
errorstring | 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आवश्यक

उदाहरण

curl -X POST "https://api.getlingara.com/v1/events" \
  -H "Authorization: Bearer $LINGARA_TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type":"world.context_changed","data":{"scene":"A night market in Taipei, just after rain","npc":{"name":"Auntie Lin","persona":"a street-food vendor who likes to haggle"},"source_lang":"en","target_lang":"zh","level":3,"tags":["market","food","chapter-2"],"generate":true}}'

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