Transmitir eventos

Parâmetros

Lingara-Versionheaderstringopcional

A versão da API com que responder a este pedido. Sem ela, um token de acesso recebe a versão a que o seu cliente está associado, e um pedido sem token recebe a versão atual. A versão ainda em desenvolvimento só é alcançada indicando-a aqui. Uma versão desconhecida responde 400 com o código api_version_unknown. GET /v1/versions lista as versões.

Last-Event-IDheaderstringopcional

O id: do último evento que recebeu. Tem prioridade sobre cursor e start.

cursorquerystringopcional

De onde continuar: o next_cursor de uma página anterior, ou o id: de um evento do fluxo. Um cursor com mais de 30 dias recebe 410 com o código cursor_expired.

startquerystringopcional

Onde começar sem cursor: latest para os eventos a partir de agora, ou oldest para todos os eventos ainda guardados.

typesqueryarray of stringopcional

Apenas estes tipos de evento, separados por vírgulas. Sem ele, todos os tipos que os âmbitos do seu token podem ler.

Respostas

200 Eventos à medida que acontecem, até done ou error

Eventos do fluxo text/event-stream

Envia um comentário keepalive a cada 15 segundos.

event EventEnvelope

idstringobrigatório

typestringobrigatório

created_atstringobrigatório

api_versionstringobrigatório

subjectstringobrigatório

dataobjectobrigatório

done Done Encerra o stream

error StreamError Encerra o stream

Chega dentro da resposta 200. A linha de status já foi enviada, então uma falha depois que o stream é aberto é informada como este evento.

codestringobrigatório

messagestringobrigatório

plan_idstring | nullopcional

Erros

410application/json

api_version_discontinued: a versão da API deste pedido foi descontinuada. cursor_expired: o cursor tem mais de 30 dias; recomece sem ele.

4XXapplication/json

O pedido foi recusado. code indica o motivo e error descreve-o por palavras.

503application/json · text/plain

O serviço está temporariamente indisponível; tente novamente após o número de segundos indicado em Retry-After. Durante a manutenção, o corpo é texto simples em vez do envelope de erro.

5XXapplication/json

O pedido foi recusado. code indica o motivo e error descreve-o por palavras.

codestringobrigatório

O motivo pelo qual o pedido foi recusado, como um código estável para ramificar a lógica: por exemplo insufficient_scope (403), rate_limited (429) e, para um cliente com faturação por utilização, spend_cap_reached (402) e metered_billing_inactive (402).

errorstringobrigatório

Exemplo

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

Prefere uma biblioteca? Veja a secção Bibliotecas.

Exemplo de fluxo

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