Lektionsplan abrufen

Parameter

Lingara-Versionheaderstringoptional

Die API-Version, unter der diese Anfrage beantwortet wird. Ohne sie erhält ein Zugriffstoken die Version, an die sein Client gebunden ist, und eine Anfrage ohne Token die aktuelle Version. Die Version in Entwicklung ist nur erreichbar, indem man sie hier nennt. Eine unbekannte Version wird mit 400 und dem Code api_version_unknown beantwortet. GET /v1/versions listet die Versionen auf.

idpathstringerforderlich

Antworten

200 Der Lektionsplan

idstringerforderlich

statusPlanStatuserforderlich

titlestring | nulloptional

source_langstringerforderlich

target_langstringerforderlich

levelintegererforderlich

created_atstringerforderlich

completed_atstring | nulloptional

ai_generatedbooleanerforderlich

contentLessonPlanContent | nulloptional

introductionstring | nulloptional

learning_objectivesarray of stringerforderlich

vocabularyarray of PlanWorderforderlich

wordstringerforderlich

pronunciationstring | nulloptional

translationstringerforderlich

setsarray of PlanSeterforderlich

numberintegererforderlich

contextstring | nulloptional

questionsarray of PlanQuestionerforderlich

typestringerforderlich

promptstringerforderlich

optionsarray of string | nulloptional

answerstringerforderlich

explanationstringerforderlich

hintstring | nulloptional

Fehler

410application/json

Die API-Version, unter der diese Anfrage beantwortet wird, wurde eingestellt. Sende eine unterstützte Version in Lingara-Version oder binde den Client an eine andere Version.

4XXapplication/json

Die Anfrage wurde abgelehnt. code nennt den Grund, und error beschreibt ihn in Worten.

503application/json · text/plain

Der Dienst ist vorübergehend nicht verfügbar; versuche es nach der in Retry-After angegebenen Anzahl Sekunden erneut. Während Wartungsarbeiten ist der Body reiner Text statt des Fehlerumschlags.

5XXapplication/json

Die Anfrage wurde abgelehnt. code nennt den Grund, und error beschreibt ihn in Worten.

codestringerforderlich

Warum die Anfrage abgelehnt wurde, als stabiler Code, nach dem du verzweigen kannst: zum Beispiel insufficient_scope (403), rate_limited (429) und, bei einem nutzungsbasiert abgerechneten Client, spend_cap_reached (402) und metered_billing_inactive (402).

errorstringerforderlich

Beispiel

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

Lieber eine Bibliothek? Siehe den Bereich Bibliotheken.