Se reconnecter à un plan de leçon
Version de l'API 2026-10-affable-towhee
Rejoint le flux de progression d'un plan encore en cours de génération. Un plan terminé répond par un unique result. Un plan encore en cours de génération sans flux actif à rejoindre répond par un unique pending ; interrogez GET /v1/lesson-plans/{id} jusqu'à ce qu'il soit terminé.
Portées lesson_plans:read
Paramètres
Lingara-Versionheaderstringfacultatif- La version de l'API sous laquelle traiter cette requête. Sans elle, un jeton d'accès obtient la version à laquelle son client est rattaché, et une requête sans jeton obtient la version actuelle. La version encore en développement ne s'atteint qu'en la nommant ici. Une version inconnue répond
400avec le codeapi_version_unknown.GET /v1/versionsliste les versions. idpathstringobligatoire
Réponses
200 La progression restante du plan, puis le plan
Événements du flux text/event-stream
Envoie un commentaire keepalive toutes les 15 secondes.
-
startedPlanStarted -
plan_idstringobligatoire
-
phasePlanPhase -
phasestringobligatoireattemptintegerobligatoire
-
resultPlanResult Termine le flux -
planLessonPlanobligatoireidstringobligatoirestatusPlanStatusobligatoiretitlestring | nullfacultatifsource_langstringobligatoiretarget_langstringobligatoirelevelintegerobligatoirecreated_atstringobligatoirecompleted_atstring | nullfacultatifai_generatedbooleanobligatoirecontentLessonPlanContent | nullfacultatifintroductionstring | nullfacultatiflearning_objectivesarray of stringobligatoirevocabularyarray of PlanWordobligatoirewordstringobligatoirepronunciationstring | nullfacultatiftranslationstringobligatoire
setsarray of PlanSetobligatoirenumberintegerobligatoirecontextstring | nullfacultatifquestionsarray of PlanQuestionobligatoiretypestringobligatoirepromptstringobligatoireoptionsarray of string | nullfacultatifanswerstringobligatoireexplanationstringobligatoirehintstring | nullfacultatif
-
pendingPlanPending Termine le flux -
plan_idstringobligatoirestatusPlanStatusobligatoire
-
errorStreamError Termine le flux -
Arrive dans la réponse 200. La ligne d'état a déjà été envoyée, donc un échec survenu après l'ouverture du flux est signalé par cet événement.
codestringobligatoiremessagestringobligatoireplan_idstring | nullfacultatif
Erreurs
410application/json- La version de l'API sous laquelle cette requête est traitée a été retirée. Envoyez une version prise en charge dans
Lingara-Version, ou rattachez le client à une autre version. 4XXapplication/json- La requête a été refusée.
codeindique pourquoi, eterrorl'explique en toutes lettres. 503application/json · text/plain- Le service est temporairement indisponible ; réessayez après le nombre de secondes indiqué dans
Retry-After. Pendant la maintenance, le corps est du texte brut plutôt que l'enveloppe d'erreur. 5XXapplication/json- La requête a été refusée.
codeindique pourquoi, eterrorl'explique en toutes lettres.
codestringobligatoirePourquoi la requête a été refusée, sous forme de code stable sur lequel brancher votre logique : par exemple
insufficient_scope(403),rate_limited(429) et, pour un client facturé à l'usage,spend_cap_reached(402) etmetered_billing_inactive(402).errorstringobligatoire
Exemple
Vous préférez une bibliothèque ? Consultez la section Bibliothèques.
Exemple de flux
event: pending
data: {"plan_id":"3f1c2a9e-5b7d-4e21-9a0c-6d8e4f2b1a37","status":"generating"}En cas de divergence entre une traduction et la référence en anglais, la référence en anglais fait foi.