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

チューター

語学チューターと1ターンずつ会話します。

• チューターに1ターン送信 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