Ottieni un piano di lezione

Parametri

Lingara-Versionheaderstringfacoltativo

La versione dell'API con cui rispondere a questa richiesta. Senza di essa, un token di accesso riceve la versione a cui è associato il suo client e una richiesta senza token riceve la versione corrente. La versione ancora in sviluppo si raggiunge solo indicandola qui. Una versione sconosciuta risponde 400 con il codice api_version_unknown. GET /v1/versions elenca le versioni.

idpathstringobbligatorio

Risposte

200 Il piano di lezione

idstringobbligatorio

statusPlanStatusobbligatorio

titlestring | nullfacoltativo

source_langstringobbligatorio

target_langstringobbligatorio

levelintegerobbligatorio

created_atstringobbligatorio

completed_atstring | nullfacoltativo

ai_generatedbooleanobbligatorio

contentLessonPlanContent | nullfacoltativo

introductionstring | nullfacoltativo

learning_objectivesarray of stringobbligatorio

vocabularyarray of PlanWordobbligatorio

wordstringobbligatorio

pronunciationstring | nullfacoltativo

translationstringobbligatorio

setsarray of PlanSetobbligatorio

numberintegerobbligatorio

contextstring | nullfacoltativo

questionsarray of PlanQuestionobbligatorio

typestringobbligatorio

promptstringobbligatorio

optionsarray of string | nullfacoltativo

answerstringobbligatorio

explanationstringobbligatorio

hintstring | nullfacoltativo

Errori

410application/json

La versione dell'API con cui si risponde a questa richiesta è stata dismessa. Invia una versione supportata in Lingara-Version, oppure associa il client a un'altra versione.

4XXapplication/json

La richiesta è stata rifiutata. code dice il motivo, e error lo spiega a parole.

503application/json · text/plain

Il servizio è temporaneamente non disponibile; riprova dopo il numero di secondi indicato in Retry-After. Durante la manutenzione il corpo è testo semplice anziché l'envelope di errore.

5XXapplication/json

La richiesta è stata rifiutata. code dice il motivo, e error lo spiega a parole.

codestringobbligatorio

Perché la richiesta è stata rifiutata, come codice stabile su cui diramare la logica: per esempio insufficient_scope (403), rate_limited (429) e, per un client con fatturazione a consumo, spend_cap_reached (402) e metered_billing_inactive (402).

errorstringobbligatorio

Esempio

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

Preferisci una libreria? Vedi la sezione Librerie.