پېښه واستوئ

پیرامیټرونه

Lingara-Versionheaderstringاختیاري

د API هغه نسخه چې دې غوښتنې ته پرې ځواب ورکول کېږي. له دې پرته، لاسرسي ټوکن هغه نسخه ترلاسه کوي چې د هغه کلاینټ ورسره تړل شوی، او بې ټوکنه غوښتنه اوسنۍ نسخه ترلاسه کوي. هغې نسخې ته چې لا هم د پراختیا په حال کې ده یوازې دلته د هغې په نومولو رسېدای شئ. نامعلومې نسخې ته د 400 او کوډ api_version_unknown سره ځواب ورکول کېږي. GET /v1/versions نسخې لېست کوي.

Idempotency-Keyheaderstringاړین

یو ارزښت چې تاسو یې د هرې پېښې لپاره ټاکئ او د بیا هڅې پر مهال یې بیا کاروئ: له ۱ تر ۲۵۵ پورې لیدل کېدونکي 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}}'

کتابتون غوره بولئ؟ د کتابتونونو برخه وګورئ.