Luo tuntisuunnitelma
API-versio 2026-10-affable-towhee
Aloittaa tuntisuunnitelman luomisen ja suoratoistaa sen edistymisen. started nimeää suunnitelman heti, kun se on olemassa, joten katkennut yhteys voi yhdistää uudelleen osoitteella GET /v1/lesson-plans/{id}/stream. Virta päättyy result- tai error-tapahtumaan. Kirjastosta tarjoiltu suunnitelma saapuu yksittäisenä result-tapahtumana.
Oikeuslaajuudet lesson_plans:write
Parametrit
Lingara-Versionheaderstringvalinnainen- API-versio, jolla tähän pyyntöön vastataan. Ilman sitä käyttötunnus saa version, johon sen asiakas on kiinnitetty, ja pyyntö ilman tunnusta saa nykyisen version. Vielä kehitteillä olevaan versioon pääsee vain nimeämällä sen tässä. Tuntemattomaan versioon vastataan
400koodillaapi_version_unknown.GET /v1/versionsluettelee versiot.
Pyynnön runko application/json
contextstringpakollinensource_langstringpakollinentarget_langstringpakollinenlevelintegerpakollinen
Vastaukset
200 Suunnitelman edistyminen, sitten suunnitelma
Virran tapahtumat text/event-stream
Lähettää keepalive-kommentin 15 sekunnin välein.
-
startedPlanStarted -
plan_idstringpakollinen
-
phasePlanPhase -
phasestringpakollinenattemptintegerpakollinen
-
resultPlanResult Päättää virran -
planLessonPlanpakollinenidstringpakollinenstatusPlanStatuspakollinentitlestring | nullvalinnainensource_langstringpakollinentarget_langstringpakollinenlevelintegerpakollinencreated_atstringpakollinencompleted_atstring | nullvalinnainenai_generatedbooleanpakollinencontentLessonPlanContent | nullvalinnainenintroductionstring | nullvalinnainenlearning_objectivesarray of stringpakollinenvocabularyarray of PlanWordpakollinenwordstringpakollinenpronunciationstring | nullvalinnainentranslationstringpakollinen
setsarray of PlanSetpakollinennumberintegerpakollinencontextstring | nullvalinnainenquestionsarray of PlanQuestionpakollinentypestringpakollinenpromptstringpakollinenoptionsarray of string | nullvalinnainenanswerstringpakollinenexplanationstringpakollinenhintstring | nullvalinnainen
-
errorStreamError Päättää virran -
Saapuu 200-vastauksen sisällä. Tilarivi on jo lähetetty, joten virran avaamisen jälkeinen virhe ilmoitetaan tänä tapahtumana.
codestringpakollinenmessagestringpakollinenplan_idstring | nullvalinnainen
Virheet
402application/json- Käytön mukaan laskutettavan asiakkaan kutsu hylättiin ennen kuin se kulutti mitään.
spend_cap_reached: asiakas tai sen tili on saavuttanut kuukausittaisen kulutusrajansa; nosta rajaa Integraatiot-sivulla.metered_billing_inactive: käytön mukainen laskutus ei ole tällä tilillä käytössä; ota se käyttöön tai päivitä maksutapa Integraatiot-sivulla. 410application/json- API-versio, jolla tähän pyyntöön vastataan, on lopetettu. Lähetä tuettu versio
Lingara-Version-otsakkeessa tai kiinnitä asiakas toiseen versioon. 4XXapplication/json- Pyyntö hylättiin.
codekertoo syyn, jaerrorkertoo sen sanoin. 503application/json · text/plain- Palvelu ei ole tilapäisesti käytettävissä; yritä uudelleen
Retry-After-otsakkeen ilmoittaman sekuntimäärän jälkeen. Huoltokatkon aikana runko on pelkkää tekstiä virhekehyksen sijaan. 5XXapplication/json- Pyyntö hylättiin.
codekertoo syyn, jaerrorkertoo sen sanoin.
codestringpakollinenMiksi pyyntö hylättiin, pysyvänä koodina, jonka mukaan voit haarautua: esimerkiksi
insufficient_scope(403),rate_limited(429) ja käytön mukaan laskutettavalle asiakkaallespend_cap_reached(402) jametered_billing_inactive(402).errorstringpakollinen
Esimerkki
Käytätkö mieluummin kirjastoa? Katso Kirjastot-osio.
Esimerkkivirta
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."}]}]}}}Jos käännös ja englanninkielinen viite poikkeavat toisistaan, englanninkielinen viite on oikea.