Voltar a ligar-se a um plano de aula
Versão da API 2026-10-affable-towhee
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
400com o códigoapi_version_unknown.GET /v1/versionslista 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.
-
startedPlanStarted -
plan_idstringobrigatório
-
phasePlanPhase -
phasestringobrigatórioattemptintegerobrigatório
-
resultPlanResult Encerra o stream -
planLessonPlanobrigatórioidstringobrigatóriostatusPlanStatusobrigatóriotitlestring | nullopcionalsource_langstringobrigatóriotarget_langstringobrigatóriolevelintegerobrigatóriocreated_atstringobrigatóriocompleted_atstring | nullopcionalai_generatedbooleanobrigatóriocontentLessonPlanContent | nullopcionalintroductionstring | nullopcionallearning_objectivesarray of stringobrigatóriovocabularyarray of PlanWordobrigatóriowordstringobrigatóriopronunciationstring | nullopcionaltranslationstringobrigatório
setsarray of PlanSetobrigatórionumberintegerobrigatóriocontextstring | nullopcionalquestionsarray of PlanQuestionobrigatóriotypestringobrigatóriopromptstringobrigatóriooptionsarray of string | nullopcionalanswerstringobrigatórioexplanationstringobrigatóriohintstring | nullopcional
-
pendingPlanPending Encerra o stream -
plan_idstringobrigatóriostatusPlanStatusobrigatório
-
errorStreamError 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óriomessagestringobrigatórioplan_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.
codeindica o motivo eerrordescreve-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.
codeindica o motivo eerrordescreve-o por palavras.
codestringobrigatórioO 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) emetered_billing_inactive(402).errorstringobrigatório
Exemplo
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.