Lingara Lingara 說明文件 學習指南 API 函式庫 App 建立 網頁版
語言: 客家話

送出事件

API 版本 2026-10-affable-towhee

post https://api.getlingara.com/v1/events

話分 Lingara 知你个遊戲裡肚發生麼个事,像係學習者行入一隻新个所在。事件只記錄一擺,用 202 回應。加 generate: true 个時節,Lingara 還會開始一份課程計畫,愛有 lesson_plans:write,限制同收費同 POST /v1/lesson-plans 共樣:reaction 講出係哪份計畫,後背會有 lesson_plan.ready 抑係 lesson_plan.failed。愛描述世界,千萬毋好送玩家个名抑係聊天內容。

權限範圍 events:write

參數

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}}'

想用函式庫?請看函式庫這一節。

假使翻譯㧯英文參考文件無共樣,就以英文參考文件為準。