Obter um plano de aula

Parâmetros

Lingara-Versionheaderstringopcional

A versão da API com que responder a este pedido. Sem ela, um token de acesso recebe a versão a que o seu cliente está associado, e um pedido sem token recebe a versão atual. A versão ainda em desenvolvimento só é alcançada indicando-a aqui. Uma versão desconhecida responde 400 com o código api_version_unknown. GET /v1/versions lista as versões.

idpathstringobrigatório

Respostas

200 O plano de aula

idstringobrigatório

statusPlanStatusobrigatório

titlestring | nullopcional

source_langstringobrigatório

target_langstringobrigatório

levelintegerobrigatório

created_atstringobrigatório

completed_atstring | nullopcional

ai_generatedbooleanobrigatório

contentLessonPlanContent | nullopcional

introductionstring | nullopcional

learning_objectivesarray of stringobrigatório

vocabularyarray of PlanWordobrigatório

wordstringobrigatório

pronunciationstring | nullopcional

translationstringobrigatório

setsarray of PlanSetobrigatório

numberintegerobrigatório

contextstring | nullopcional

questionsarray of PlanQuestionobrigatório

typestringobrigatório

promptstringobrigatório

optionsarray of string | nullopcional

answerstringobrigatório

explanationstringobrigatório

hintstring | nullopcional

Erros

410application/json

A versão da API com que este pedido é respondido foi descontinuada. Envie uma versão suportada em Lingara-Version, ou associe o cliente a outra versão.

4XXapplication/json

O pedido foi recusado. code indica o motivo e error descreve-o por palavras.

503application/json · text/plain

O serviço está temporariamente indisponível; tente novamente após o número de segundos indicado em Retry-After. Durante a manutenção, o corpo é texto simples em vez do envelope de erro.

5XXapplication/json

O pedido foi recusado. code indica o motivo e error descreve-o por palavras.

codestringobrigatório

O motivo pelo qual o pedido foi recusado, como um código estável para ramificar a lógica: por exemplo insufficient_scope (403), rate_limited (429) e, para um cliente com faturação por utilização, spend_cap_reached (402) e metered_billing_inactive (402).

errorstringobrigatório

Exemplo

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

Prefere uma biblioteca? Veja a secção Bibliotecas.