イベントをストリーム配信
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 バージョン。指定がない場合、アクセストークンはそのクライアントに固定されたバージョンを、トークンのないリクエストは現行バージョンを受け取ります。開発中のバージョンには、ここで指定した場合にのみアクセスできます。不明なバージョンにはコード
api_version_unknownとともに400を返します。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: {}翻訳と英語版リファレンスの内容が異なる場合は、英語版リファレンスが正しいものとします。