Sambungkan kembali ke rencana pelajaran
Versi API 2026-10-affable-towhee
Bergabung kembali ke stream progres rencana yang masih dibuat. Rencana yang sudah selesai menjawab dengan satu result. Rencana yang masih dibuat tanpa stream aktif untuk diikuti menjawab dengan satu pending; lakukan polling GET /v1/lesson-plans/{id} sampai selesai.
Cakupan lesson_plans:read
Parameter
Lingara-Versionheaderstringopsional- Versi API yang digunakan untuk menjawab permintaan ini. Tanpanya, token akses mendapatkan versi yang disematkan pada kliennya, dan permintaan tanpa token mendapatkan versi saat ini. Versi yang masih dalam pengembangan hanya dapat dicapai dengan menyebutkannya di sini. Versi yang tidak dikenal dijawab
400dengan kodeapi_version_unknown.GET /v1/versionsmencantumkan versi-versinya. idpathstringwajib
Respons
200 Sisa progres rencana, lalu rencananya
Peristiwa stream text/event-stream
Mengirim komentar keepalive setiap 15 detik.
-
startedPlanStarted -
plan_idstringwajib
-
phasePlanPhase -
phasestringwajibattemptintegerwajib
-
resultPlanResult Mengakhiri stream -
planLessonPlanwajibidstringwajibstatusPlanStatuswajibtitlestring | nullopsionalsource_langstringwajibtarget_langstringwajiblevelintegerwajibcreated_atstringwajibcompleted_atstring | nullopsionalai_generatedbooleanwajibcontentLessonPlanContent | nullopsionalintroductionstring | nullopsionallearning_objectivesarray of stringwajibvocabularyarray of PlanWordwajibwordstringwajibpronunciationstring | nullopsionaltranslationstringwajib
setsarray of PlanSetwajibnumberintegerwajibcontextstring | nullopsionalquestionsarray of PlanQuestionwajibtypestringwajibpromptstringwajiboptionsarray of string | nullopsionalanswerstringwajibexplanationstringwajibhintstring | nullopsional
-
pendingPlanPending Mengakhiri stream -
plan_idstringwajibstatusPlanStatuswajib
-
errorStreamError Mengakhiri stream -
Tiba di dalam respons 200. Baris status sudah dikirim, sehingga kegagalan setelah stream dibuka dilaporkan sebagai event ini.
codestringwajibmessagestringwajibplan_idstring | nullopsional
Galat
410application/json- Versi API yang digunakan untuk menjawab permintaan ini telah dihentikan. Kirim versi yang didukung di
Lingara-Version, atau sematkan klien ke versi lain. 4XXapplication/json- Permintaan ditolak.
codemenyebutkan alasannya, danerrormenjelaskannya dengan kata-kata. 503application/json · text/plain- Layanan sementara tidak tersedia; coba lagi setelah jumlah detik di
Retry-After. Selama pemeliharaan, isi respons berupa teks biasa, bukan amplop galat. 5XXapplication/json- Permintaan ditolak.
codemenyebutkan alasannya, danerrormenjelaskannya dengan kata-kata.
codestringwajibAlasan permintaan ditolak, sebagai kode tetap untuk percabangan: misalnya
insufficient_scope(403),rate_limited(429) dan, untuk klien dengan penagihan per pemakaian,spend_cap_reached(402) danmetered_billing_inactive(402).errorstringwajib
Contoh
Lebih suka pustaka? Lihat bagian Pustaka.
Contoh stream
event: pending
data: {"plan_id":"3f1c2a9e-5b7d-4e21-9a0c-6d8e4f2b1a37","status":"generating"}Jika terjemahan berbeda dengan referensi berbahasa Inggris, referensi berbahasa Inggris yang berlaku.