Stream peristiwa

Parameter

Lingara-Versionheaderstringopsional

Versi API yang digunakan untuk menjawab permintaan ini. Tanpanya, token akses mendapatkan versi yang disematkan pada kliennya, dan permintaan tanpa token mendapatkan versi saat ini. Versi yang masih dalam pengembangan hanya dapat dicapai dengan menyebutkannya di sini. Versi yang tidak dikenal dijawab 400 dengan kode api_version_unknown. GET /v1/versions mencantumkan versi-versinya.

Last-Event-IDheaderstringopsional

id: dari peristiwa terakhir yang Anda terima. Ini diutamakan di atas cursor dan start.

cursorquerystringopsional

Dari mana melanjutkan: next_cursor dari halaman sebelumnya, atau id: dari peristiwa stream. Kursor yang lebih tua dari 30 hari dijawab 410 dengan kode cursor_expired.

startquerystringopsional

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

typesqueryarray of stringopsional

Hanya jenis peristiwa ini, dipisahkan koma. Tanpanya, setiap jenis yang dapat dibaca oleh cakupan token Anda.

Respons

200 Peristiwa saat terjadi, hingga done atau error

Peristiwa stream text/event-stream

Mengirim komentar keepalive setiap 15 detik.

event EventEnvelope

idstringwajib

typestringwajib

created_atstringwajib

api_versionstringwajib

subjectstringwajib

dataobjectwajib

done Done Mengakhiri stream

error StreamError Mengakhiri stream

Tiba di dalam respons 200. Baris status sudah dikirim, sehingga kegagalan setelah stream dibuka dilaporkan sebagai event ini.

codestringwajib

messagestringwajib

plan_idstring | nullopsional

Galat

410application/json

api_version_discontinued: versi API permintaan ini telah dihentikan. cursor_expired: kursor lebih tua dari 30 hari; mulai lagi tanpa kursor.

4XXapplication/json

Permintaan ditolak. code menyebutkan alasannya, dan error menjelaskannya dengan kata-kata.

503application/json · text/plain

Layanan sementara tidak tersedia; coba lagi setelah jumlah detik di Retry-After. Selama pemeliharaan, isi respons berupa teks biasa, bukan amplop galat.

5XXapplication/json

Permintaan ditolak. code menyebutkan alasannya, dan error menjelaskannya dengan kata-kata.

codestringwajib

Alasan permintaan ditolak, sebagai kode tetap untuk percabangan: misalnya insufficient_scope (403), rate_limited (429) dan, untuk klien dengan penagihan per pemakaian, 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 bagian Pustaka.

Contoh stream

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