Lingara API 參考文件

錯誤

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必填

詞彙

依學習者的程度產生詞彙表。

• 產生詞彙表 POST /v1/vocab/stream

課程計畫

建立課程計畫、讀取課程計畫，以及重新連線到仍在產生中的課程計畫。

• 建立課程計畫 POST /v1/lesson-plans
• 取得課程計畫 GET /v1/lesson-plans/{id}
• 重新連線到課程計畫 GET /v1/lesson-plans/{id}/stream

家教

與語言家教逐輪對話。

• 傳送一輪家教對話 POST /v1/tutor/message

事件

讀取你帳號中發生的事件，可逐頁讀取，也可以使用串流。

• 列出事件 GET /v1/events
• 傳送事件 POST /v1/events
• 事件串流 GET /v1/events/stream

帳戶

查看剩餘額度。

• 取得剩餘額度 GET /v1/usage

參考

本文件的機器可讀形式。

• 取得本文件 GET /v1/openapi.json
• 取得事件文件 GET /v1/asyncapi.json
• 列出 API 版本 GET /v1/versions
• 取得一個 API 版本 GET /v1/versions/{id}

事件目錄

Lingara 會將你帳戶的課程計畫和用量所發生的事記錄為事件，並接收來自你的遊戲或應用程式的事件。每個事件無論以哪種方式傳遞，都使用同一種封包，事件目錄列出了全部事件。 Webhook 與事件

• Lingara → 你 lesson_plan.ready
• Lingara → 你 lesson_plan.failed
• Lingara → 你 usage.threshold_reached
• Lingara → 你 webhook.test
• Lingara → 你 app.installed
• Lingara → 你 app.uninstalled

• 你 → Lingara world.context_changed
• 你 → Lingara world.practice_requested