Obtener un plan de lección

Parámetros

Lingara-Versionheaderstringopcional

La versión de la API con la que se responde a esta solicitud. Sin ella, un token de acceso recibe la versión a la que está vinculado su cliente, y una solicitud sin token recibe la versión actual. La versión aún en desarrollo solo se alcanza nombrándola aquí. Una versión desconocida responde 400 con el código api_version_unknown. GET /v1/versions enumera las versiones.

idpathstringobligatorio

Respuestas

200 El plan de lección

idstringobligatorio

statusPlanStatusobligatorio

titlestring | nullopcional

source_langstringobligatorio

target_langstringobligatorio

levelintegerobligatorio

created_atstringobligatorio

completed_atstring | nullopcional

ai_generatedbooleanobligatorio

contentLessonPlanContent | nullopcional

introductionstring | nullopcional

learning_objectivesarray of stringobligatorio

vocabularyarray of PlanWordobligatorio

wordstringobligatorio

pronunciationstring | nullopcional

translationstringobligatorio

setsarray of PlanSetobligatorio

numberintegerobligatorio

contextstring | nullopcional

questionsarray of PlanQuestionobligatorio

typestringobligatorio

promptstringobligatorio

optionsarray of string | nullopcional

answerstringobligatorio

explanationstringobligatorio

hintstring | nullopcional

Errores

410application/json

La versión de la API con la que se responde a esta solicitud se ha retirado. Envía una versión admitida en Lingara-Version o vincula el cliente a otra versión.

4XXapplication/json

La solicitud fue rechazada. code indica el motivo y error lo explica con palabras.

503application/json · text/plain

El servicio no está disponible temporalmente; vuelve a intentarlo tras el número de segundos indicado en Retry-After. Durante el mantenimiento, el cuerpo es texto sin formato en lugar del sobre de error.

5XXapplication/json

La solicitud fue rechazada. code indica el motivo y error lo explica con palabras.

codestringobligatorio

Por qué se rechazó la solicitud, como un código estable con el que ramificar: por ejemplo insufficient_scope (403), rate_limited (429) y, para un cliente con facturación por uso, spend_cap_reached (402) y metered_billing_inactive (402).

errorstringobligatorio

Ejemplo

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

¿Prefieres una biblioteca? Consulta la sección Bibliotecas.