Planeke dersê çêbike
Guhertoya API 2026-10-affable-towhee
Dest bi çêkirina planeke dersê dike û pêşketina wê stream dike. started planê hema ku çêbû nav dike, ji ber vê yekê girêdaneke qutbûyî dikare bi GET /v1/lesson-plans/{id}/stream ji nû ve girê bide. Stream bi result an error diqede. Planeke ku ji pirtûkxaneyê tê wek resultekî tenê digihîje.
Scope lesson_plans:write
Parametre
Lingara-Versionheaderstringvebijarkî- Guhertoya API ya ku ev daxwaz pê tê bersivandin. Bêyî wê, tokena gihîştinê guhertoya ku klientê wê pê ve girêdayî ye distîne, û daxwazeke bê token guhertoya niha distîne. Guhertoya ku hîn di pêşxistinê de ye tenê bi binavkirina wê li vir tê gihîştin. Guhertoyeke nenas bi
400û kodaapi_version_unknowntê bersivandin.GET /v1/versionsguhertoyan rêz dike.
Naveroka daxwazê application/json
contextstringpêwîstsource_langstringpêwîsttarget_langstringpêwîstlevelintegerpêwîst
Bersiv
200 Pêşketina planê, paşê plan
Bûyerên streamê text/event-stream
Her 15 çirkeyan şîroveyeke keepalive dişîne.
-
startedPlanStarted -
plan_idstringpêwîst
-
phasePlanPhase -
phasestringpêwîstattemptintegerpêwîst
-
resultPlanResult Weşanê diqedîne -
planLessonPlanpêwîstidstringpêwîststatusPlanStatuspêwîsttitlestring | nullvebijarkîsource_langstringpêwîsttarget_langstringpêwîstlevelintegerpêwîstcreated_atstringpêwîstcompleted_atstring | nullvebijarkîai_generatedbooleanpêwîstcontentLessonPlanContent | nullvebijarkîintroductionstring | nullvebijarkîlearning_objectivesarray of stringpêwîstvocabularyarray of PlanWordpêwîstwordstringpêwîstpronunciationstring | nullvebijarkîtranslationstringpêwîst
setsarray of PlanSetpêwîstnumberintegerpêwîstcontextstring | nullvebijarkîquestionsarray of PlanQuestionpêwîsttypestringpêwîstpromptstringpêwîstoptionsarray of string | nullvebijarkîanswerstringpêwîstexplanationstringpêwîsthintstring | nullvebijarkî
-
errorStreamError Weşanê diqedîne -
Di nav bersiva 200 de tê. Rêza rewşê berê hatiye şandin, ji ber vê yekê têkçûnek piştî vebûna weşanê wekî vê bûyerê tê ragihandin.
codestringpêwîstmessagestringpêwîstplan_idstring | nullvebijarkî
Çewtî
402application/json- Bangeke klienteke pîvandî hat redkirin berî ku tiştek xerc bike.
spend_cap_reached: klient an hesabê wê gihîştiye sînorê xercê yê mehane; sînor li rûpela Entegrasyon bilind bike.metered_billing_inactive: fatûrekirina li gorî bikaranînê ji bo vî hesabî ne çalak e; wê li rûpela Entegrasyon saz bike an rêbaza dayînê nû bike. 410application/json- Guhertoya API ya ku ev daxwaz pê tê bersivandin hate rawestandin. Guhertoyeke piştgirîkirî di
Lingara-Versionde bişîne, an klientê bi guhertoyeke din ve girê bide. 4XXapplication/json- Daxwaz hate redkirin.
codesedemê dibêje, ûerrorwê bi gotinan dibêje. 503application/json · text/plain- Xizmet bi demkî ne berdest e; piştî hejmara çirkeyên di
Retry-Afterde dîsa biceribîne. Di dema lênêrînê de naverok nivîsa sade ye, ne zerfa çewtiyê. 5XXapplication/json- Daxwaz hate redkirin.
codesedemê dibêje, ûerrorwê bi gotinan dibêje.
codestringpêwîstÇima daxwaz hat redkirin, wek kodeke domdar ku mirov li gorî wê şax dike: bo nimûne
insufficient_scope(403),rate_limited(429) û, ji bo klienteke pîvandî,spend_cap_reached(402) ûmetered_billing_inactive(402).errorstringpêwîst
Mînak
Pirtûkxaneyek tercîh dikî? Beşa Pirtûkxaneyan bibîne.
Mînaka streamê
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."}]}]}}}Ger wergerek û referansa Îngilîzî ji hev cuda bin, referansa Îngilîzî rast e.