Lingara Lingara Documentação Guias API Bibliotecas Aplicações Criar Aplicação web
Idioma: Português

Voltar a ligar-se a um plano de aula

Versão da API 2026-10-affable-towhee

get https://api.getlingara.com/v1/lesson-plans/{id}/stream

Volta a juntar-se ao stream de progresso de um plano que ainda está a ser gerado. Um plano concluído responde com um único result. Um plano ainda em geração sem stream ativo a que se juntar responde com um único pending; consulte GET /v1/lesson-plans/{id} periodicamente até estar concluído.

Âmbitos lesson_plans:read

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.
idpathstringobrigatório

Respostas

200 O progresso restante do plano e, depois, o plano

Eventos do fluxo text/event-stream

Envia um comentário keepalive a cada 15 segundos.

started PlanStarted
plan_idstringobrigatório
phase PlanPhase
phasestringobrigatório
attemptintegerobrigatório
result PlanResult Encerra o stream
planLessonPlanobrigatório
idstringobrigatório
statusPlanStatusobrigatório
titlestring | nullopcional
source_langstringobrigatório
target_langstringobrigatório
levelintegerobrigatório
created_atstringobrigatório
completed_atstring | nullopcional
ai_generatedbooleanobrigatório
contentLessonPlanContent | nullopcional
introductionstring | nullopcional
learning_objectivesarray of stringobrigatório
vocabularyarray of PlanWordobrigatório
wordstringobrigatório
pronunciationstring | nullopcional
translationstringobrigatório
setsarray of PlanSetobrigatório
numberintegerobrigatório
contextstring | nullopcional
questionsarray of PlanQuestionobrigatório
typestringobrigatório
promptstringobrigatório
optionsarray of string | nullopcional
answerstringobrigatório
explanationstringobrigatório
hintstring | nullopcional
pending PlanPending Encerra o stream
plan_idstringobrigatório
statusPlanStatusobrigatório
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
A versão da API com que este pedido é respondido foi descontinuada. Envie uma versão suportada em Lingara-Version, ou associe o cliente a outra versão.
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

Linguagem do exemplo de código

curl

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

TypeScript

for await (const ev of client.streamLessonPlan({ id: planId })) {
  if (ev.event === "result") console.log("ready:", ev.data.plan.title);
  if (ev.event === "pending") console.log("still", ev.data.status, "- try again later");
}

Rust

use lingara::models::StreamLessonPlanEvent;

let mut stream = client.stream_lesson_plan(&plan_id).await?;
while let Some(event) = stream.next().await {
    match event? {
        StreamLessonPlanEvent::Result(result) => println!("ready: {}", result.plan.title.unwrap_or_default()),
        StreamLessonPlanEvent::Pending(pending) => println!("still {:?} - try again later", pending.status),
        _ => {}
    }
}

Go

// Rejoin a plan still generating, with the plan_id from its started event.
s, err := client.StreamLessonPlan(ctx, "3f1c2a9e-5b7d-4e21-9a0c-6d8e4f2b1a37")
if err != nil {
	return err
}
defer s.Close()
for ev, err := range s.Events() {
	if err != nil {
		return err
	}
	switch e := ev.(type) {
	case lingara.StreamLessonPlanEventResult:
		fmt.Println("ready:", e.Data.Plan.ID)
	case lingara.StreamLessonPlanEventPending:
		fmt.Println("still", e.Data.Status, "- rejoin later")
	}
}

Java

import com.getlingara.client.model.StreamLessonPlanEvent;

try (EventStream<StreamLessonPlanEvent> stream = client.streamLessonPlan(planId)) {
  for (StreamLessonPlanEvent event : stream) {
    if (event instanceof StreamLessonPlanEvent.Result result) {
      System.out.println(result.data().getPlan().getTitle());
    } else if (event instanceof StreamLessonPlanEvent.Pending pending) {
      // Still generating elsewhere: ask again later.
      System.out.println("pending: " + pending.data().getStatus());
    }
  }
}

Kotlin

import com.getlingara.kotlin.LingaraClient
import com.getlingara.kotlin.model.StreamLessonPlanEvent

client.streamLessonPlan(planId).use { stream ->
    stream.collect { event ->
        when (event) {
            is StreamLessonPlanEvent.Result -> println(event.data.plan.title)
            // Still generating elsewhere: ask again later.
            is StreamLessonPlanEvent.Pending -> println("pending: ${event.data.status}")
            else -> Unit
        }
    }
}

Ruby

client.stream_lesson_plan(plan_id) do |event|
  case event
  in Lingara::StreamLessonPlanEventResult => result then puts "ready: #{result.data.plan.title}"
  in Lingara::StreamLessonPlanEventPending => pending then puts "still #{pending.data.status}, try again later"
  else nil
  end
end

PHP

use Lingara\Stream\StreamLessonPlanEvent;

foreach ($client->streamLessonPlan($planId) as $event) {
    if ($event instanceof StreamLessonPlanEvent\Result) {
        echo 'ready: ', $event->data->getPlan()->getTitle(), "\n";
    } elseif ($event instanceof StreamLessonPlanEvent\Pending) {
        echo 'still ', $event->data->getStatus()->value, ", try again later\n";
    }
}

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

Exemplo de fluxo

event: pending
data: {"plan_id":"3f1c2a9e-5b7d-4e21-9a0c-6d8e4f2b1a37","status":"generating"}

Se uma tradução e a referência em inglês divergirem, prevalece a referência em inglês.