Stroom gebeurtenisse

API-weergawe 2026-10-affable-towhee

get https://api.getlingara.com/v1/events/stream

Stuur elke gebeurtenis wat jou kliënt kan sien terwyl dit gebeur. Die stroom eindig met done ná 15 minute, of met error; koppel weer met die laaste id: in Last-Event-ID om sonder 'n gaping voort te gaan.

Omvange events:read

Parameters

Lingara-Versionheaderstringopsioneel: Die API-weergawe waaronder hierdie versoek beantwoord word. Daarsonder kry 'n toegangstoken die weergawe waaraan sy kliënt gekoppel is, en 'n versoek sonder 'n token kry die huidige weergawe. Die weergawe wat nog ontwikkel word, is slegs bereikbaar deur dit hier te noem. 'n Onbekende weergawe gee 400 met kode api_version_unknown. GET /v1/versions lys die weergawes.
Last-Event-IDheaderstringopsioneel: Die id: van die laaste gebeurtenis wat jy ontvang het. Dit geniet voorrang bo cursor en start.
cursorquerystringopsioneel: Waarvandaan om voort te gaan: 'n vorige bladsy se next_cursor, of 'n stroomgebeurtenis se id:. 'n Wyser ouer as 30 dae gee 410 met kode cursor_expired.
startquerystringopsioneel: Waar om sonder 'n wyser te begin: latest vir gebeurtenisse van nou af, of oldest vir elke gebeurtenis wat nog bewaar word.
typesqueryarray of stringopsioneel: Slegs hierdie gebeurtenistipes, met kommas geskei. Daarsonder, elke tipe wat jou token se bestekke kan lees.

Antwoorde

200 Gebeurtenisse soos hulle gebeur, tot done of error

Stroomgebeurtenisse `text/event-stream`

Stuur elke 15 sekondes 'n keepalive-opmerking.

event EventEnvelope

idstringverplig
typestringverplig
created_atstringverplig
api_versionstringverplig
subjectstringverplig
dataobjectverplig

done Done Beëindig die stroom

error StreamError Beëindig die stroom

Kom binne die 200-antwoord aan. Die statusreël is reeds gestuur, so 'n fout nadat die stroom oopgemaak is, word as hierdie gebeurtenis gerapporteer.

codestringverplig
messagestringverplig
plan_idstring | nullopsioneel

Foute

410application/json: api_version_discontinued: hierdie versoek se API-weergawe is gestaak. cursor_expired: die wyser is ouer as 30 dae; begin weer sonder een.
4XXapplication/json: Die versoek is geweier. code sê hoekom, en error sê dit in woorde.
503application/json · text/plain: Die diens is tydelik onbeskikbaar; probeer weer na die aantal sekondes in Retry-After. Tydens onderhoud is die liggaam gewone teks eerder as die foutomhulsel.
5XXapplication/json: Die versoek is geweier. code sê hoekom, en error sê dit in woorde.

codestringverplig: Waarom die versoek geweier is, as 'n stabiele kode om op te vertak: byvoorbeeld insufficient_scope (403), rate_limited (429) en, vir 'n gemeterde kliënt, spend_cap_reached (402) en metered_billing_inactive (402).
errorstringverplig

Voorbeeld

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

Verkies jy 'n biblioteek? Sien die Biblioteke-afdeling.

Voorbeeldstroom

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

Indien 'n vertaling en die Engelse verwysing verskil, is die Engelse verwysing korrek.