جریان رویدادها

پارامترها

Lingara-Versionheaderstringاختیاری

نسخهٔ API‌ای که این درخواست با آن پاسخ داده می‌شود. بدون آن، توکن دسترسی نسخه‌ای را می‌گیرد که کلاینتش به آن متصل است، و درخواستی بدون توکن نسخهٔ فعلی را می‌گیرد. به نسخه‌ای که هنوز در حال توسعه است فقط با نام‌بردن آن در اینجا می‌توان رسید. نسخهٔ ناشناخته با 400 و کد api_version_unknown پاسخ داده می‌شود. GET /v1/versions نسخه‌ها را فهرست می‌کند.

Last-Event-IDheaderstringاختیاری

id: آخرین رویدادی که دریافت کرده‌اید. این مقدار بر cursor و start مقدم است.

cursorquerystringاختیاری

از کجا ادامه دهید: next_cursor یک صفحهٔ قبلی، یا id: یک رویداد جریان. نشانگری قدیمی‌تر از ۳۰ روز با 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: نشانگر قدیمی‌تر از ۳۰ روز است؛ بدون آن دوباره شروع کنید.

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