事件串流

參數

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