وەرگرتنی پلانی وانە

پارامەترەکان

Lingara-Versionheaderstringئارەزوومەندانە

ئەو وەشانەی API کە ئەم داواکارییەی پێ وەڵام دەدرێتەوە. بەبێ ئەمە، تۆکنی دەستگەیشتن ئەو وەشانە وەردەگرێت کە کڕیارەکەی پێیەوە بەستراوە، و داواکارییەکی بێ تۆکن وەشانی ئێستا وەردەگرێت. وەشانێک کە هێشتا لە گەشەپێداندایە تەنها بە ناوهێنانی لێرە دەگەیەندرێت. وەشانێکی نەناسراو بە 400 لەگەڵ کۆدی api_version_unknown وەڵام دەدرێتەوە. GET /v1/versions وەشانەکان لیست دەکات.

idpathstringپێویست

وەڵامەکان

200 پلانی وانەکە

idstringپێویست

statusPlanStatusپێویست

titlestring | nullئارەزوومەندانە

source_langstringپێویست

target_langstringپێویست

levelintegerپێویست

created_atstringپێویست

completed_atstring | nullئارەزوومەندانە

ai_generatedbooleanپێویست

contentLessonPlanContent | nullئارەزوومەندانە

introductionstring | nullئارەزوومەندانە

learning_objectivesarray of stringپێویست

vocabularyarray of PlanWordپێویست

wordstringپێویست

pronunciationstring | nullئارەزوومەندانە

translationstringپێویست

setsarray of PlanSetپێویست

numberintegerپێویست

contextstring | nullئارەزوومەندانە

questionsarray of PlanQuestionپێویست

typestringپێویست

promptstringپێویست

optionsarray of string | nullئارەزوومەندانە

answerstringپێویست

explanationstringپێویست

hintstring | nullئارەزوومەندانە

هەڵەکان

410application/json

ئەو وەشانەی API کە ئەم داواکارییەی پێ وەڵام دەدرێتەوە ڕاگیراوە. وەشانێکی پشتگیریکراو لە Lingara-Version بنێرە، یان کڕیارەکە بە وەشانێکی ترەوە ببەستەوە.

4XXapplication/json

داواکارییەکە ڕەتکرایەوە. code هۆکارەکەی دەڵێت، و error بە وشە ڕوونی دەکاتەوە.

503application/json · text/plain

خزمەتگوزارییەکە بە شێوەیەکی کاتی بەردەست نییە؛ دوای ئەو ژمارە چرکەیەی کە Retry-After دیاری دەکات دووبارە هەوڵ بدەرەوە. لە کاتی چاککردنەوەدا، ناوەڕۆکی وەڵامەکە دەقی سادەیە نەک پێچراوەی هەڵە.

5XXapplication/json

داواکارییەکە ڕەتکرایەوە. code هۆکارەکەی دەڵێت، و error بە وشە ڕوونی دەکاتەوە.

codestringپێویست

هۆکاری ڕەتکردنەوەی داواکارییەکە، وەک کۆدێکی جێگیر بۆ لقبوونەوە لەسەری: بۆ نموونە insufficient_scope (403)، rate_limited (429) و، بۆ کلاینتێکی پێوانەکراو، spend_cap_reached (402) و metered_billing_inactive (402).

errorstringپێویست

نموونە

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

کتێبخانەیەکت پێ باشترە؟ بەشی کتێبخانەکان ببینە.