ناردنی ڕووداوێک

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

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

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

Idempotency-Keyheaderstringپێویست

بەهایەک کە بۆ هەر ڕووداوێک هەڵیدەبژێریت و کاتی دووبارە هەوڵدانەوە دووبارە بەکاری دەهێنیتەوە: 1 تا 255 پیتی ASCIIی بینراو، وەک UUID. هەوڵدانەوە بە هەمان کلیل یەکەم وەڵام وەردەگرێتەوە و دووبارە پارەی لێ وەرناگیرێت، تەنانەت ئەگەر ناوەڕۆکەکەی جیاواز بێت. بەبێ کلیلێکی دروست، داواکارییەکە بە 400 و کۆدی idempotency_key_required وەڵام دەدرێتەوە.

ناوەڕۆکی داواکاری application/json

typestringپێویست

dataWorldPracticeRequestedپێویست

topicstringپێویست

source_langstringپێویست

target_langstringپێویست

levelintegerپێویست

tagsarray of stringئارەزوومەندانە

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

وەڵامەکان

202 ڕووداوەکە تۆمار کرا

idstringپێویست

typestringپێویست

created_atstringپێویست

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

statusReactionStatusپێویست

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

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

باری پلانەکە کاتێک ڕووداوەکە وەرگیرا. تەنها generating بەڵێن دەدات کە lesson_plan.ready یان lesson_plan.failed دێت. هەر بەهایەکی تر پلانێکە لە کتێبخانەوە دابین کراوە، کە ئێستا دەتوانیت بە GET /v1/lesson-plans/{id} بیخوێنیتەوە.

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

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

هەڵەکان

402application/json

بانگکردنێکی کلاینتێکی پێوانەکراو ڕەتکرایەوە پێش ئەوەی هیچ خەرج بکات. spend_cap_reached: کلاینتەکە یان هەژمارەکەی گەیشتووەتە سنووری خەرجیی مانگانەی؛ لە پەڕەی یەکخستنەکان سنوورەکە بەرز بکەرەوە. metered_billing_inactive: پارەدانی بەپێی بەکارهێنان بۆ ئەم هەژمارە چالاک نییە؛ لە پەڕەی یەکخستنەکان ڕێکی بخە یان شێوازی پارەدان نوێ بکەرەوە.

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 -X POST "https://api.getlingara.com/v1/events" \
  -H "Authorization: Bearer $LINGARA_TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type":"world.context_changed","data":{"scene":"A night market in Taipei, just after rain","npc":{"name":"Auntie Lin","persona":"a street-food vendor who likes to haggle"},"source_lang":"en","target_lang":"zh","level":3,"tags":["market","food","chapter-2"],"generate":true}}'

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