傳送事件

參數

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

想用函式庫？請參閱「函式庫」一節。