Gebeurtenissen streamen
API-versie 2026-10-affable-towhee
Stuurt elke gebeurtenis die je client mag zien zodra die plaatsvindt. De stream eindigt na 15 minuten met done, of met error; maak opnieuw verbinding met de laatste id: in Last-Event-ID om zonder gat verder te gaan.
Bevoegdheden events:read
Parameters
Lingara-Versionheaderstringoptioneel- De API-versie waaronder dit verzoek wordt beantwoord. Zonder deze krijgt een toegangstoken de versie waaraan zijn client is gekoppeld, en een verzoek zonder token de huidige versie. De versie die nog in ontwikkeling is, bereik je alleen door die hier te noemen. Een onbekende versie geeft
400met codeapi_version_unknown.GET /v1/versionstoont de versies. Last-Event-IDheaderstringoptioneel- De
id:van de laatste gebeurtenis die je hebt ontvangen. Die gaat voor opcursorenstart. cursorquerystringoptioneel- Waar je verdergaat: de
next_cursorvan een eerdere pagina, of deid:van een streamgebeurtenis. Een cursor ouder dan 30 dagen krijgt410met codecursor_expired. startquerystringoptioneel- Waar je begint zonder cursor:
latestvoor gebeurtenissen vanaf nu, ofoldestvoor elke gebeurtenis die nog bewaard wordt. typesqueryarray of stringoptioneel- Alleen deze gebeurtenistypen, gescheiden door komma's. Zonder deze parameter elk type dat de scopes van je token mogen lezen.
Antwoorden
200 Gebeurtenissen zodra ze plaatsvinden, tot done of error
Stream-events text/event-stream
Stuurt elke 15 seconden een keepalive-commentaar.
-
eventEventEnvelope -
idstringverplichttypestringverplichtcreated_atstringverplichtapi_versionstringverplichtsubjectstringverplichtdataobjectverplicht
-
doneDone Beëindigt de stream -
errorStreamError Beëindigt de stream -
Komt binnen het 200-antwoord aan. De statusregel is al verzonden, dus een fout nadat de stream is geopend wordt als deze gebeurtenis gemeld.
codestringverplichtmessagestringverplichtplan_idstring | nulloptioneel
Fouten
410application/jsonapi_version_discontinued: de API-versie van dit verzoek is stopgezet.cursor_expired: de cursor is ouder dan 30 dagen; begin opnieuw zonder cursor.4XXapplication/json- Het verzoek is geweigerd.
codegeeft de reden aan enerrorbeschrijft die in woorden. 503application/json · text/plain- De dienst is tijdelijk niet beschikbaar; probeer het opnieuw na het aantal seconden in
Retry-After. Tijdens onderhoud is de body platte tekst in plaats van de foutenvelop. 5XXapplication/json- Het verzoek is geweigerd.
codegeeft de reden aan enerrorbeschrijft die in woorden.
codestringverplichtWaarom het verzoek is geweigerd, als stabiele code om op te vertakken: bijvoorbeeld
insufficient_scope(403),rate_limited(429) en, voor een client met verbruiksafrekening,spend_cap_reached(402) enmetered_billing_inactive(402).errorstringverplicht
Voorbeeld
curl -N "https://api.getlingara.com/v1/events/stream" \
-H "Authorization: Bearer $LINGARA_TOKEN"Liever een bibliotheek? Zie de sectie Bibliotheken.
Voorbeeldstream
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: {}Als een vertaling afwijkt van de Engelse referentie, is de Engelse referentie juist.