اتصال دوباره به طرح درس
نسخهٔ API 2026-10-affable-towhee
دوباره به جریان پیشرفت طرحی که هنوز در حال ساخت است میپیوندد. طرح تکمیلشده با یک result پاسخ میدهد. طرحی که هنوز در حال ساخت است و جریان زندهای برای پیوستن ندارد، با یک pending پاسخ میدهد؛ GET /v1/lesson-plans/{id} را بهطور دورهای فراخوانی کنید تا کامل شود.
دامنههای دسترسی lesson_plans:read
پارامترها
Lingara-Versionheaderstringاختیاری- نسخهٔ APIای که این درخواست با آن پاسخ داده میشود. بدون آن، توکن دسترسی نسخهای را میگیرد که کلاینتش به آن متصل است، و درخواستی بدون توکن نسخهٔ فعلی را میگیرد. به نسخهای که هنوز در حال توسعه است فقط با نامبردن آن در اینجا میتوان رسید. نسخهٔ ناشناخته با
400و کدapi_version_unknownپاسخ داده میشود.GET /v1/versionsنسخهها را فهرست میکند. idpathstringالزامی
پاسخها
200 پیشرفت باقیماندهٔ طرح، سپس خود طرح
رویدادهای جریان text/event-stream
هر 15 ثانیه یک توضیح keepalive میفرستد.
-
startedPlanStarted -
plan_idstringالزامی
-
phasePlanPhase -
phasestringالزامیattemptintegerالزامی
-
resultPlanResult جریان را پایان میدهد -
planLessonPlanالزامیidstringالزامیstatusPlanStatusالزامیtitlestring | nullاختیاریsource_langstringالزامیtarget_langstringالزامیlevelintegerالزامیcreated_atstringالزامیcompleted_atstring | nullاختیاریai_generatedbooleanالزامیcontentLessonPlanContent | nullاختیاریintroductionstring | nullاختیاریlearning_objectivesarray of stringالزامیvocabularyarray of PlanWordالزامیwordstringالزامیpronunciationstring | nullاختیاریtranslationstringالزامی
setsarray of PlanSetالزامیnumberintegerالزامیcontextstring | nullاختیاریquestionsarray of PlanQuestionالزامیtypestringالزامیpromptstringالزامیoptionsarray of string | nullاختیاریanswerstringالزامیexplanationstringالزامیhintstring | nullاختیاری
-
pendingPlanPending جریان را پایان میدهد -
plan_idstringالزامیstatusPlanStatusالزامی
-
errorStreamError جریان را پایان میدهد -
درون پاسخ 200 میرسد. خط وضعیت پیشتر ارسال شده است، پس هر خطایی پس از باز شدن جریان بهصورت این رویداد گزارش میشود.
codestringالزامیmessagestringالزامیplan_idstring | nullاختیاری
خطاها
410application/json- نسخهٔ APIای که این درخواست با آن پاسخ داده میشود متوقف شده است. یک نسخهٔ پشتیبانیشده را در
Lingara-Versionبفرستید، یا کلاینت را به نسخهٔ دیگری متصل کنید. 4XXapplication/json- درخواست رد شد.
codeدلیل آن را مشخص میکند وerrorآن را با کلمات بیان میکند. 503application/json · text/plain- سرویس موقتاً در دسترس نیست؛ پس از تعداد ثانیههای ذکرشده در
Retry-Afterدوباره تلاش کنید. در زمان نگهداری، بدنهٔ پاسخ بهجای پوشش خطا، متن ساده است. 5XXapplication/json- درخواست رد شد.
codeدلیل آن را مشخص میکند وerrorآن را با کلمات بیان میکند.
codestringالزامیدلیل رد شدن درخواست، بهصورت کدی ثابت که میتوان بر اساس آن تصمیم گرفت: برای نمونه
insufficient_scope(403)،rate_limited(429) و، برای یک کلاینت مصرفی،spend_cap_reached(402) وmetered_billing_inactive(402).errorstringالزامی
نمونه
کتابخانه را ترجیح میدهید؟ بخش کتابخانهها را ببینید.
نمونهٔ جریان
event: pending
data: {"plan_id":"3f1c2a9e-5b7d-4e21-9a0c-6d8e4f2b1a37","status":"generating"}اگر ترجمه با مرجع انگلیسی تفاوت داشته باشد، مرجع انگلیسی معتبر است.