Suoratoista tapahtumat

Parametrit

Lingara-Versionheaderstringvalinnainen

API-versio, jolla tähän pyyntöön vastataan. Ilman sitä käyttötunnus saa version, johon sen asiakas on kiinnitetty, ja pyyntö ilman tunnusta saa nykyisen version. Vielä kehitteillä olevaan versioon pääsee vain nimeämällä sen tässä. Tuntemattomaan versioon vastataan 400 koodilla api_version_unknown. GET /v1/versions luettelee versiot.

Last-Event-IDheaderstringvalinnainen

Viimeisimmän vastaanottamasi tapahtuman id:. Se on etusijalla cursor- ja start-arvoihin nähden.

cursorquerystringvalinnainen

Mistä jatketaan: aiemman sivun next_cursor tai virran tapahtuman id:. Yli 30 päivää vanhaan kohdistimeen vastataan 410 koodilla cursor_expired.

startquerystringvalinnainen

Mistä aloitetaan ilman kohdistinta: latest tapahtumille tästä eteenpäin tai oldest jokaiselle vielä säilytetylle tapahtumalle.

typesqueryarray of stringvalinnainen

Vain nämä tapahtumatyypit pilkuilla eroteltuina. Ilman sitä jokainen tyyppi, jonka tunnuksesi oikeudet voivat lukea.

Vastaukset

200 Tapahtumat sitä mukaa kuin ne tapahtuvat, kunnes done tai error

Virran tapahtumat text/event-stream

Lähettää keepalive-kommentin 15 sekunnin välein.

event EventEnvelope

idstringpakollinen

typestringpakollinen

created_atstringpakollinen

api_versionstringpakollinen

subjectstringpakollinen

dataobjectpakollinen

done Done Päättää virran

error StreamError Päättää virran

Saapuu 200-vastauksen sisällä. Tilarivi on jo lähetetty, joten virran avaamisen jälkeinen virhe ilmoitetaan tänä tapahtumana.

codestringpakollinen

messagestringpakollinen

plan_idstring | nullvalinnainen

Virheet

410application/json

api_version_discontinued: tämän pyynnön API-versio on lopetettu. cursor_expired: kohdistin on yli 30 päivää vanha; aloita alusta ilman sitä.

4XXapplication/json

Pyyntö hylättiin. code kertoo syyn, ja error kertoo sen sanoin.

503application/json · text/plain

Palvelu ei ole tilapäisesti käytettävissä; yritä uudelleen Retry-After-otsakkeen ilmoittaman sekuntimäärän jälkeen. Huoltokatkon aikana runko on pelkkää tekstiä virhekehyksen sijaan.

5XXapplication/json

Pyyntö hylättiin. code kertoo syyn, ja error kertoo sen sanoin.

codestringpakollinen

Miksi pyyntö hylättiin, pysyvänä koodina, jonka mukaan voit haarautua: esimerkiksi insufficient_scope (403), rate_limited (429) ja käytön mukaan laskutettavalle asiakkaalle spend_cap_reached (402) ja metered_billing_inactive (402).

errorstringpakollinen

Esimerkki

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

Käytätkö mieluummin kirjastoa? Katso Kirjastot-osio.

Esimerkkivirta

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