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