攞課程計劃

參數

Lingara-Versionheaderstring選填

回應呢個請求所用嘅 API 版本。冇呢個嘅話，存取權杖會用佢嘅用戶端綁定嘅版本，冇權杖嘅請求會用而家嘅版本。仲喺開發中嘅版本，只可以喺度指明先用到。唔認得嘅版本會回 400，代碼係 api_version_unknown。GET /v1/versions 會列出所有版本。

idpathstring必填

回應

200 課程計劃

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選填

錯誤

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必填

例子

curl "https://api.getlingara.com/v1/lesson-plans/$ID" \
  -H "Authorization: Bearer $LINGARA_TOKEN"

const plan = await client.getLessonPlan({ id: planId });
console.log(plan.status, plan.title);

let plan = client.get_lesson_plan(&plan_id).await?;
println!("{:?} {}", plan.status, plan.title.as_deref().unwrap_or("(untitled)"));

plan, err := client.GetLessonPlan(ctx, "3f1c2a9e-5b7d-4e21-9a0c-6d8e4f2b1a37")
if err != nil {
	return err
}
fmt.Println(plan.Value.Status, plan.Value.CreatedAt)

import com.getlingara.client.model.LessonPlan;

LessonPlan plan = client.getLessonPlan(planId).body();
System.out.println(plan.getTitle() + " (" + plan.getStatus() + ")");

val plan = client.getLessonPlan(planId).body
println("${plan.title} (${plan.status})")

plan = client.get_lesson_plan(plan_id).value
puts "#{plan.title} (#{plan.status})"
plan.content&.vocabulary&.each { |word| puts "#{word.word}: #{word.translation}" }

$plan = $client->getLessonPlan($planId)->value;
echo $plan->getTitle(), ' (', $plan->getStatus()->value, ")\n";

想用程式庫？睇吓程式庫部分。