Sambung semula kepada rancangan pelajaran
Versi API 2026-10-affable-towhee
Menyertai semula strim kemajuan rancangan yang masih dijana. Rancangan yang telah siap menjawab dengan satu result. Rancangan yang masih dijana tanpa strim langsung untuk disertai menjawab dengan satu pending; tinjau GET /v1/lesson-plans/{id} sehingga ia siap.
Skop lesson_plans:read
Parameter
Lingara-Versionheaderstringpilihan- Versi API yang digunakan untuk menjawab permintaan ini. Tanpanya, token akses mendapat versi yang dipautkan kepada kliennya, dan permintaan tanpa token mendapat versi semasa. Versi yang masih dalam pembangunan hanya boleh dicapai dengan menamakannya di sini. Versi yang tidak dikenali dijawab
400dengan kodapi_version_unknown.GET /v1/versionsmenyenaraikan versi. idpathstringwajib
Respons
200 Baki kemajuan rancangan, kemudian rancangan itu
Peristiwa strim text/event-stream
Menghantar komen keepalive setiap 15 saat.
-
startedPlanStarted -
plan_idstringwajib
-
phasePlanPhase -
phasestringwajibattemptintegerwajib
-
resultPlanResult Menamatkan strim -
planLessonPlanwajibidstringwajibstatusPlanStatuswajibtitlestring | nullpilihansource_langstringwajibtarget_langstringwajiblevelintegerwajibcreated_atstringwajibcompleted_atstring | nullpilihanai_generatedbooleanwajibcontentLessonPlanContent | nullpilihanintroductionstring | nullpilihanlearning_objectivesarray of stringwajibvocabularyarray of PlanWordwajibwordstringwajibpronunciationstring | nullpilihantranslationstringwajib
setsarray of PlanSetwajibnumberintegerwajibcontextstring | nullpilihanquestionsarray of PlanQuestionwajibtypestringwajibpromptstringwajiboptionsarray of string | nullpilihananswerstringwajibexplanationstringwajibhintstring | nullpilihan
-
pendingPlanPending Menamatkan strim -
plan_idstringwajibstatusPlanStatuswajib
-
errorStreamError Menamatkan strim -
Tiba di dalam respons 200. Baris status telah pun dihantar, jadi kegagalan selepas strim dibuka dilaporkan sebagai peristiwa ini.
codestringwajibmessagestringwajibplan_idstring | nullpilihan
Ralat
410application/json- Versi API yang digunakan untuk menjawab permintaan ini telah dihentikan. Hantar versi yang disokong dalam
Lingara-Version, atau pautkan klien kepada versi lain. 4XXapplication/json- Permintaan ditolak.
codemenyatakan sebabnya, danerrormenerangkannya dengan perkataan. 503application/json · text/plain- Perkhidmatan tidak tersedia buat sementara waktu; cuba lagi selepas bilangan saat dalam
Retry-After. Semasa penyelenggaraan, kandungan ialah teks biasa dan bukan sampul ralat. 5XXapplication/json- Permintaan ditolak.
codemenyatakan sebabnya, danerrormenerangkannya dengan perkataan.
codestringwajibSebab permintaan ditolak, sebagai kod stabil untuk dijadikan asas percabangan: contohnya
insufficient_scope(403),rate_limited(429) dan, bagi klien bermeter,spend_cap_reached(402) danmetered_billing_inactive(402).errorstringwajib
Contoh
Lebih suka pustaka? Lihat bahagian Pustaka.
Contoh strim
event: pending
data: {"plan_id":"3f1c2a9e-5b7d-4e21-9a0c-6d8e4f2b1a37","status":"generating"}Jika terjemahan dan rujukan bahasa Inggeris berbeza, rujukan bahasa Inggeris adalah yang betul.