Strim peristiwa

Parameter

Lingara-Versionheaderstringpilihan

Versi API yang digunakan untuk menjawab permintaan ini. Tanpanya, token akses mendapat versi yang dipautkan kepada kliennya, dan permintaan tanpa token mendapat versi semasa. Versi yang masih dalam pembangunan hanya boleh dicapai dengan menamakannya di sini. Versi yang tidak dikenali dijawab 400 dengan kod api_version_unknown. GET /v1/versions menyenaraikan versi.

Last-Event-IDheaderstringpilihan

id: peristiwa terakhir yang anda terima. Ia diutamakan berbanding cursor dan start.

cursorquerystringpilihan

Dari mana hendak diteruskan: next_cursor halaman sebelumnya, atau id: peristiwa strim. Kursor yang lebih lama daripada 30 hari dijawab dengan 410 bersama kod cursor_expired.

startquerystringpilihan

Tempat bermula tanpa kursor: latest untuk peristiwa mulai sekarang, atau oldest untuk setiap peristiwa yang masih disimpan.

typesqueryarray of stringpilihan

Hanya jenis peristiwa ini, dipisahkan dengan koma. Tanpanya, setiap jenis yang boleh dibaca oleh skop token anda.

Respons

200 Peristiwa semasa ia berlaku, sehingga done atau error

Peristiwa strim text/event-stream

Menghantar komen keepalive setiap 15 saat.

event EventEnvelope

idstringwajib

typestringwajib

created_atstringwajib

api_versionstringwajib

subjectstringwajib

dataobjectwajib

done Done Menamatkan strim

error StreamError Menamatkan strim

Tiba di dalam respons 200. Baris status telah pun dihantar, jadi kegagalan selepas strim dibuka dilaporkan sebagai peristiwa ini.

codestringwajib

messagestringwajib

plan_idstring | nullpilihan

Ralat

410application/json

api_version_discontinued: versi API permintaan ini telah dihentikan. cursor_expired: kursor lebih lama daripada 30 hari; mulakan semula tanpanya.

4XXapplication/json

Permintaan ditolak. code menyatakan sebabnya, dan error menerangkannya dengan perkataan.

503application/json · text/plain

Perkhidmatan tidak tersedia buat sementara waktu; cuba lagi selepas bilangan saat dalam Retry-After. Semasa penyelenggaraan, kandungan ialah teks biasa dan bukan sampul ralat.

5XXapplication/json

Permintaan ditolak. code menyatakan sebabnya, dan error menerangkannya dengan perkataan.

codestringwajib

Sebab permintaan ditolak, sebagai kod stabil untuk dijadikan asas percabangan: contohnya insufficient_scope (403), rate_limited (429) dan, bagi klien bermeter, spend_cap_reached (402) dan metered_billing_inactive (402).

errorstringwajib

Contoh

curl -N "https://api.getlingara.com/v1/events/stream" \
  -H "Authorization: Bearer $LINGARA_TOKEN"

Lebih suka pustaka? Lihat bahagian Pustaka.

Contoh strim

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