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