Cipta rancangan pelajaran
Versi API 2026-10-affable-towhee
Mula menjana rancangan pelajaran dan menstrim kemajuannya. started menamakan rancangan sebaik sahaja ia wujud, jadi sambungan yang terputus boleh bersambung semula dengan GET /v1/lesson-plans/{id}/stream. Strim berakhir dengan result atau error. Rancangan yang diambil dari pustaka tiba sebagai satu result sahaja.
Skop lesson_plans:write
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.
Kandungan permintaan application/json
contextstringwajibsource_langstringwajibtarget_langstringwajiblevelintegerwajib
Respons
200 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
-
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
402application/json- Panggilan klien bermeter telah ditolak sebelum ia membelanjakan apa-apa.
spend_cap_reached: klien atau akaunnya telah mencapai had perbelanjaan bulanannya; naikkan had di halaman Integrasi.metered_billing_inactive: pengebilan bermeter tidak aktif untuk akaun ini; sediakannya, atau kemas kini kaedah pembayaran, di halaman Integrasi. 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: started
data: {"plan_id":"3f1c2a9e-5b7d-4e21-9a0c-6d8e4f2b1a37"}
event: phase
data: {"phase":"selecting_vocabulary","attempt":1}
event: result
data: {"plan":{"id":"3f1c2a9e-5b7d-4e21-9a0c-6d8e4f2b1a37","status":"complete","title":"At the night market","source_lang":"en","target_lang":"zh","level":2,"created_at":"2026-09-23T10:00:00Z","completed_at":"2026-09-23T10:00:41Z","ai_generated":true,"content":{"introduction":"Order food and ask prices at a night market.","learning_objectives":["Ask how much something costs"],"vocabulary":[{"word":"多少钱","pronunciation":"duōshao qián","translation":"how much"}],"sets":[{"number":1,"questions":[{"type":"multiple_choice_word","prompt":"Which word asks for a price?","options":["多少钱","谢谢"],"answer":"多少钱","explanation":"多少钱 means how much money."}]}]}}}Jika terjemahan dan rujukan bahasa Inggeris berbeza, rujukan bahasa Inggeris adalah yang betul.