串流事件

參數

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