取得課程計畫

參數

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";

想用函式庫？請參閱「函式庫」一節。