Ambil rencana pelajaran

Parameter

Lingara-Versionheaderstringopsional

Versi API yang digunakan untuk menjawab permintaan ini. Tanpanya, token akses mendapatkan versi yang disematkan pada kliennya, dan permintaan tanpa token mendapatkan versi saat ini. Versi yang masih dalam pengembangan hanya dapat dicapai dengan menyebutkannya di sini. Versi yang tidak dikenal dijawab 400 dengan kode api_version_unknown. GET /v1/versions mencantumkan versi-versinya.

idpathstringwajib

Respons

200 Rencana pelajaran

idstringwajib

statusPlanStatuswajib

titlestring | nullopsional

source_langstringwajib

target_langstringwajib

levelintegerwajib

created_atstringwajib

completed_atstring | nullopsional

ai_generatedbooleanwajib

contentLessonPlanContent | nullopsional

introductionstring | nullopsional

learning_objectivesarray of stringwajib

vocabularyarray of PlanWordwajib

wordstringwajib

pronunciationstring | nullopsional

translationstringwajib

setsarray of PlanSetwajib

numberintegerwajib

contextstring | nullopsional

questionsarray of PlanQuestionwajib

typestringwajib

promptstringwajib

optionsarray of string | nullopsional

answerstringwajib

explanationstringwajib

hintstring | nullopsional

Galat

410application/json

Versi API yang digunakan untuk menjawab permintaan ini telah dihentikan. Kirim versi yang didukung di Lingara-Version, atau sematkan klien ke versi lain.

4XXapplication/json

Permintaan ditolak. code menyebutkan alasannya, dan error menjelaskannya dengan kata-kata.

503application/json · text/plain

Layanan sementara tidak tersedia; coba lagi setelah jumlah detik di Retry-After. Selama pemeliharaan, isi respons berupa teks biasa, bukan amplop galat.

5XXapplication/json

Permintaan ditolak. code menyebutkan alasannya, dan error menjelaskannya dengan kata-kata.

codestringwajib

Alasan permintaan ditolak, sebagai kode tetap untuk percabangan: misalnya insufficient_scope (403), rate_limited (429) dan, untuk klien dengan penagihan per pemakaian, spend_cap_reached (402) dan metered_billing_inactive (402).

errorstringwajib

Contoh

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

Lebih suka pustaka? Lihat bagian Pustaka.