ستریمی ڕووداوەکان

پارامەترەکان

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: {}