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