I-stream ang mga event

Mga parameter

Lingara-Versionheaderstringopsyonal

Ang bersyon ng API na gagamitin sa pagsagot sa kahilingang ito. Kung wala ito, makukuha ng access token ang bersyong naka-pin sa client nito, at makukuha ng kahilingang walang token ang kasalukuyang bersyon. Maaabot lang ang bersyong dine-develop pa sa pamamagitan ng pagpangalan dito. Ang hindi kilalang bersyon ay sinasagot ng 400 na may code na api_version_unknown. Inililista ng GET /v1/versions ang mga bersyon.

Last-Event-IDheaderstringopsyonal

Ang id: ng huling event na natanggap mo. Mas nangingibabaw ito kaysa sa cursor at start.

cursorquerystringopsyonal

Kung saan magpapatuloy: ang next_cursor ng naunang pahina, o ang id: ng isang event sa stream. Ang cursor na mas luma sa 30 araw ay sinasagot ng 410 na may code na cursor_expired.

startquerystringopsyonal

Kung saan magsisimula nang walang cursor: latest para sa mga event mula ngayon, o oldest para sa bawat event na nakatago pa.

typesqueryarray of stringopsyonal

Ang mga uri ng event na ito lamang, pinaghihiwalay ng kuwit. Kung wala ito, bawat uri na mababasa ng mga scope ng iyong token.

Mga tugon

200 Mga event habang nangyayari, hanggang done o error

Mga event ng stream text/event-stream

Nagpapadala ng keepalive na komento bawat 15 segundo.

event EventEnvelope

idstringkailangan

typestringkailangan

created_atstringkailangan

api_versionstringkailangan

subjectstringkailangan

dataobjectkailangan

done Done Tinatapos ang stream

error StreamError Tinatapos ang stream

Dumarating sa loob ng 200 na tugon. Naipadala na ang status line, kaya ang pagkabigo matapos mabuksan ang stream ay iniuulat bilang event na ito.

codestringkailangan

messagestringkailangan

plan_idstring | nullopsyonal

Mga error

410application/json

api_version_discontinued: itinigil na ang bersyon ng API ng request na ito. cursor_expired: mas luma sa 30 araw ang cursor; magsimula muli nang wala ito.

4XXapplication/json

Tinanggihan ang kahilingan. Sinasabi ng code kung bakit, at ipinapaliwanag ito ng error sa mga salita.

503application/json · text/plain

Pansamantalang hindi available ang serbisyo; subukang muli pagkatapos ng bilang ng segundong nasa Retry-After. Habang may maintenance, plain text ang body sa halip na ang error envelope.

5XXapplication/json

Tinanggihan ang kahilingan. Sinasabi ng code kung bakit, at ipinapaliwanag ito ng error sa mga salita.

codestringkailangan

Kung bakit tinanggihan ang request, bilang isang matatag na code na mapagbabatayan ng iyong programa: halimbawa insufficient_scope (403), rate_limited (429) at, para sa isang metered client, spend_cap_reached (402) at metered_billing_inactive (402).

errorstringkailangan

Halimbawa

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

Mas gusto ang library? Tingnan ang seksyong Mga library.

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