Kry 'n lesplan

Parameters

Lingara-Versionheaderstringopsioneel

Die API-weergawe waaronder hierdie versoek beantwoord word. Daarsonder kry 'n toegangstoken die weergawe waaraan sy kliënt gekoppel is, en 'n versoek sonder 'n token kry die huidige weergawe. Die weergawe wat nog ontwikkel word, is slegs bereikbaar deur dit hier te noem. 'n Onbekende weergawe gee 400 met kode api_version_unknown. GET /v1/versions lys die weergawes.

idpathstringverplig

Antwoorde

200 Die lesplan

idstringverplig

statusPlanStatusverplig

titlestring | nullopsioneel

source_langstringverplig

target_langstringverplig

levelintegerverplig

created_atstringverplig

completed_atstring | nullopsioneel

ai_generatedbooleanverplig

contentLessonPlanContent | nullopsioneel

introductionstring | nullopsioneel

learning_objectivesarray of stringverplig

vocabularyarray of PlanWordverplig

wordstringverplig

pronunciationstring | nullopsioneel

translationstringverplig

setsarray of PlanSetverplig

numberintegerverplig

contextstring | nullopsioneel

questionsarray of PlanQuestionverplig

typestringverplig

promptstringverplig

optionsarray of string | nullopsioneel

answerstringverplig

explanationstringverplig

hintstring | nullopsioneel

Foute

410application/json

Die API-weergawe waaronder hierdie versoek beantwoord word, is gestaak. Stuur 'n ondersteunde weergawe in Lingara-Version, of koppel die kliënt aan 'n ander weergawe.

4XXapplication/json

Die versoek is geweier. code sê hoekom, en error sê dit in woorde.

503application/json · text/plain

Die diens is tydelik onbeskikbaar; probeer weer na die aantal sekondes in Retry-After. Tydens onderhoud is die liggaam gewone teks eerder as die foutomhulsel.

5XXapplication/json

Die versoek is geweier. code sê hoekom, en error sê dit in woorde.

codestringverplig

Waarom die versoek geweier is, as 'n stabiele kode om op te vertak: byvoorbeeld insufficient_scope (403), rate_limited (429) en, vir 'n gemeterde kliënt, spend_cap_reached (402) en metered_billing_inactive (402).

errorstringverplig

Voorbeeld

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

Verkies jy 'n biblioteek? Sien die Biblioteke-afdeling.