Lingara Lingara 說明文件 學習指南 API 函式庫 App 建立 網頁版
語言: 客家話

取得課程計畫

API 版本 2026-10-affable-towhee

get https://api.getlingara.com/v1/lesson-plans/{id}

轉你擁有个課程計畫。還在產生个計畫還毋曾有 content。

權限範圍 lesson_plans:read

參數

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

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

TypeScript

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

Rust

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

Go

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

Java

import com.getlingara.client.model.LessonPlan;

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

Kotlin

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

Ruby

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

PHP

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

想用函式庫?請看函式庫這一節。

假使翻譯㧯英文參考文件無共樣,就以英文參考文件為準。