串流事件
API 版本 2026-10-affable-towhee
get https://api.getlingara.com/v1/events/stream
你个用戶端看得到个每一隻事件一發生就送出。串流 15 分鐘後用 done 結束,或者用 error 結束;用 Last-Event-ID 裡背最尾个 id: 重新連線,就做得無缺口繼續。
權限範圍 events:read
參數
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 註解。
-
eventEventEnvelope -
idstring必填typestring必填created_atstring必填api_versionstring必填subjectstring必填dataobject必填
-
doneDone 結束串流 -
errorStreamError 結束串流 -
喺 200 回應裡肚到。狀態行已經送出去了,所以串流開始以後个失敗會用這隻事件來報告。
codestring必填messagestring必填plan_idstring | null選填
錯誤
410application/jsonapi_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: {}假使翻譯㧯英文參考文件無共樣,就以英文參考文件為準。