Lingara Lingara 說明文件 學習指南 API 函式庫 應用程式 起造 網頁版
語言: 閩南語

送出事件

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

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

若是翻譯佮英文參考文件無仝,就以英文參考文件為準。