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

想用程式庫?睇吓程式庫部分。

如果譯本同英文參考文件有出入,以英文參考文件為準。