串流事件

參數

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