घटनाओं की स्ट्रीम

पैरामीटर

Lingara-Versionheaderstringवैकल्पिक

वह API संस्करण जिसके अंतर्गत इस अनुरोध का उत्तर दिया जाए। इसके बिना, एक्सेस टोकन को वह संस्करण मिलता है जिससे उसका क्लाइंट जुड़ा है, और बिना टोकन वाले अनुरोध को वर्तमान संस्करण मिलता है। विकासाधीन संस्करण तक केवल उसे यहाँ नाम देकर पहुँचा जा सकता है। अज्ञात संस्करण का उत्तर 400 और कोड api_version_unknown होता है। GET /v1/versions संस्करणों की सूची देता है।

Last-Event-IDheaderstringवैकल्पिक

आपको मिली अंतिम घटना का id:। इसे cursor और start पर प्राथमिकता मिलती है।

cursorquerystringवैकल्पिक

कहाँ से जारी रखें: किसी पिछले पेज का next_cursor, या किसी स्ट्रीम घटना का id:। 30 दिन से पुराने कर्सर का उत्तर 410 और कोड cursor_expired होता है।

startquerystringवैकल्पिक

कर्सर के बिना कहाँ से शुरू करें: अभी से होने वाली घटनाओं के लिए latest, या अभी तक रखी गई हर घटना के लिए oldest।

typesqueryarray of stringवैकल्पिक

केवल ये घटना प्रकार, अल्पविराम से अलग। इसके बिना, हर वह प्रकार जिसे आपके टोकन के स्कोप पढ़ सकते हैं।

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

200 घटनाएँ जैसे-जैसे होती हैं, done या error तक

स्ट्रीम इवेंट text/event-stream

हर 15 सेकंड में एक keepalive टिप्पणी भेजता है।

event EventEnvelope

idstringआवश्यक

typestringआवश्यक

created_atstringआवश्यक

api_versionstringआवश्यक

subjectstringआवश्यक

dataobjectआवश्यक

done Done स्ट्रीम समाप्त करता है

error StreamError स्ट्रीम समाप्त करता है

200 प्रतिक्रिया के भीतर आता है। स्थिति पंक्ति पहले ही भेजी जा चुकी है, इसलिए स्ट्रीम खुलने के बाद की विफलता इस इवेंट के रूप में बताई जाती है।

codestringआवश्यक

messagestringआवश्यक

plan_idstring | nullवैकल्पिक

त्रुटियाँ

410application/json

api_version_discontinued: इस अनुरोध का API संस्करण बंद कर दिया गया है। cursor_expired: कर्सर 30 दिन से पुराना है; उसके बिना फिर से शुरू करें।

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 -N "https://api.getlingara.com/v1/events/stream" \
  -H "Authorization: Bearer $LINGARA_TOKEN"

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

उदाहरण स्ट्रीम

id: djEuNzQ0MTIuOTkxLjE3OTAyNDk1NjQ
event: event
data: {"id":"lgr_evt_4f2a9c1e7b3d4e5f8a9b0c1d2e3f4a5b","type":"lesson_plan.ready","created_at":"2026-10-01T09:12:44Z","api_version":"2026-09-equipped-boxfish","subject":"lgr_sub_0f1e2d3c4b5a69788796a5b4c3d2e1f0","data":{"plan_id":"3f1c2a9e-5b7d-4e21-9a0c-6d8e4f2b1a37","status":"complete","title":"At the night market","source_lang":"en","target_lang":"zh","level":2}}

id: djEuNzQ0MzAuMC4xNzkwMjUwNDY0
event: done
data: {}