Pata mpango wa somo

Vigezo

Lingara-Versionheaderstringsi lazima

Toleo la API la kutumia kujibu ombi hili. Bila hilo, tokeni ya ufikiaji hupata toleo ambalo mteja wake ameunganishwa nalo, na ombi lisilo na tokeni hupata toleo la sasa. Toleo ambalo bado linaendelezwa linafikiwa tu kwa kulitaja hapa. Toleo lisilojulikana hujibiwa 400 pamoja na msimbo api_version_unknown. GET /v1/versions huorodhesha matoleo.

idpathstringinahitajika

Majibu

200 Mpango wa somo

idstringinahitajika

statusPlanStatusinahitajika

titlestring | nullsi lazima

source_langstringinahitajika

target_langstringinahitajika

levelintegerinahitajika

created_atstringinahitajika

completed_atstring | nullsi lazima

ai_generatedbooleaninahitajika

contentLessonPlanContent | nullsi lazima

introductionstring | nullsi lazima

learning_objectivesarray of stringinahitajika

vocabularyarray of PlanWordinahitajika

wordstringinahitajika

pronunciationstring | nullsi lazima

translationstringinahitajika

setsarray of PlanSetinahitajika

numberintegerinahitajika

contextstring | nullsi lazima

questionsarray of PlanQuestioninahitajika

typestringinahitajika

promptstringinahitajika

optionsarray of string | nullsi lazima

answerstringinahitajika

explanationstringinahitajika

hintstring | nullsi lazima

Hitilafu

410application/json

Toleo la API linalotumika kujibu ombi hili limesitishwa. Tuma toleo linalotumika katika Lingara-Version, au unganisha mteja na toleo lingine.

4XXapplication/json

Ombi limekataliwa. code inaeleza sababu, na error inaieleza kwa maneno.

503application/json · text/plain

Huduma haipatikani kwa muda; jaribu tena baada ya idadi ya sekunde zilizo katika Retry-After. Wakati wa matengenezo, mwili wa jibu ni maandishi ya kawaida badala ya bahasha ya hitilafu.

5XXapplication/json

Ombi limekataliwa. code inaeleza sababu, na error inaieleza kwa maneno.

codestringinahitajika

Sababu ya ombi kukataliwa, kama msimbo thabiti wa kufanyia maamuzi: kwa mfano insufficient_scope (403), rate_limited (429) na, kwa mteja anayetozwa kwa matumizi, spend_cap_reached (402) na metered_billing_inactive (402).

errorstringinahitajika

Mfano

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

Unapendelea maktaba? Tazama sehemu ya Maktaba.