Trasmetti gli eventi

Versione API 2026-10-affable-towhee

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

Invia ogni evento che il tuo client può vedere non appena accade. Il flusso termina con done dopo 15 minuti, oppure con error; riconnettiti con l'ultimo id: in Last-Event-ID per continuare senza interruzioni.

Scope events:read

Parametri

Lingara-Versionheaderstringfacoltativo: La versione dell'API con cui rispondere a questa richiesta. Senza di essa, un token di accesso riceve la versione a cui è associato il suo client e una richiesta senza token riceve la versione corrente. La versione ancora in sviluppo si raggiunge solo indicandola qui. Una versione sconosciuta risponde 400 con il codice api_version_unknown. GET /v1/versions elenca le versioni.
Last-Event-IDheaderstringfacoltativo: L'id: dell'ultimo evento ricevuto. Ha la precedenza su cursor e start.
cursorquerystringfacoltativo: Da dove continuare: il next_cursor di una pagina precedente o l'id: di un evento del flusso. Un cursore più vecchio di 30 giorni riceve 410 con codice cursor_expired.
startquerystringfacoltativo: Da dove iniziare senza cursore: latest per gli eventi da adesso in poi, oppure oldest per ogni evento ancora conservato.
typesqueryarray of stringfacoltativo: Solo questi tipi di evento, separati da virgole. Senza, tutti i tipi che gli ambiti del tuo token possono leggere.

Risposte

200 Gli eventi mentre accadono, fino a done o error

Eventi dello stream `text/event-stream`

Invia un commento keepalive ogni 15 secondi.

event EventEnvelope

idstringobbligatorio
typestringobbligatorio
created_atstringobbligatorio
api_versionstringobbligatorio
subjectstringobbligatorio
dataobjectobbligatorio

done Done Termina lo stream

error StreamError Termina lo stream

Arriva all'interno della risposta 200. La riga di stato è già stata inviata, quindi un errore dopo l'apertura dello stream viene segnalato come questo evento.

codestringobbligatorio
messagestringobbligatorio
plan_idstring | nullfacoltativo

Errori

410application/json: api_version_discontinued: la versione dell'API di questa richiesta è stata ritirata. cursor_expired: il cursore ha più di 30 giorni; ricomincia senza.
4XXapplication/json: La richiesta è stata rifiutata. code dice il motivo, e error lo spiega a parole.
503application/json · text/plain: Il servizio è temporaneamente non disponibile; riprova dopo il numero di secondi indicato in Retry-After. Durante la manutenzione il corpo è testo semplice anziché l'envelope di errore.
5XXapplication/json: La richiesta è stata rifiutata. code dice il motivo, e error lo spiega a parole.

codestringobbligatorio: Perché la richiesta è stata rifiutata, come codice stabile su cui diramare la logica: per esempio insufficient_scope (403), rate_limited (429) e, per un client con fatturazione a consumo, spend_cap_reached (402) e metered_billing_inactive (402).
errorstringobbligatorio

Esempio

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

Preferisci una libreria? Vedi la sezione Librerie.

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

In caso di discrepanza tra una traduzione e il riferimento in inglese, fa fede il riferimento in inglese.