Obtenir un plan de leçon

Paramètres

Lingara-Versionheaderstringfacultatif

La version de l'API sous laquelle traiter cette requête. Sans elle, un jeton d'accès obtient la version à laquelle son client est rattaché, et une requête sans jeton obtient la version actuelle. La version encore en développement ne s'atteint qu'en la nommant ici. Une version inconnue répond 400 avec le code api_version_unknown. GET /v1/versions liste les versions.

idpathstringobligatoire

Réponses

200 Le plan de leçon

idstringobligatoire

statusPlanStatusobligatoire

titlestring | nullfacultatif

source_langstringobligatoire

target_langstringobligatoire

levelintegerobligatoire

created_atstringobligatoire

completed_atstring | nullfacultatif

ai_generatedbooleanobligatoire

contentLessonPlanContent | nullfacultatif

introductionstring | nullfacultatif

learning_objectivesarray of stringobligatoire

vocabularyarray of PlanWordobligatoire

wordstringobligatoire

pronunciationstring | nullfacultatif

translationstringobligatoire

setsarray of PlanSetobligatoire

numberintegerobligatoire

contextstring | nullfacultatif

questionsarray of PlanQuestionobligatoire

typestringobligatoire

promptstringobligatoire

optionsarray of string | nullfacultatif

answerstringobligatoire

explanationstringobligatoire

hintstring | nullfacultatif

Erreurs

410application/json

La version de l'API sous laquelle cette requête est traitée a été retirée. Envoyez une version prise en charge dans Lingara-Version, ou rattachez le client à une autre version.

4XXapplication/json

La requête a été refusée. code indique pourquoi, et error l'explique en toutes lettres.

503application/json · text/plain

Le service est temporairement indisponible ; réessayez après le nombre de secondes indiqué dans Retry-After. Pendant la maintenance, le corps est du texte brut plutôt que l'enveloppe d'erreur.

5XXapplication/json

La requête a été refusée. code indique pourquoi, et error l'explique en toutes lettres.

codestringobligatoire

Pourquoi la requête a été refusée, sous forme de code stable sur lequel brancher votre logique : par exemple insufficient_scope (403), rate_limited (429) et, pour un client facturé à l'usage, spend_cap_reached (402) et metered_billing_inactive (402).

errorstringobligatoire

Exemple

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

Vous préférez une bibliothèque ? Consultez la section Bibliothèques.