単語リストを生成
API バージョン 2026-10-affable-towhee
post https://api.getlingara.com/v1/vocab/stream
指定したレベルの単語リストをストリーミングします。ストリームはまずリストの詳細を含む started を送り、単語ごとに item イベントを1つ送り、最後に done を送ります。リストの準備ができるまではキープアライブのコメントのみを送ります。
スコープ vocab:generate
パラメーター
Lingara-Versionheaderstring任意- このリクエストに応答する API バージョン。指定がない場合、アクセストークンはそのクライアントに固定されたバージョンを、トークンのないリクエストは現行バージョンを受け取ります。開発中のバージョンには、ここで指定した場合にのみアクセスできます。不明なバージョンにはコード
api_version_unknownとともに400を返します。GET /v1/versionsでバージョンを一覧できます。
リクエスト本文 application/json
levelinteger必須source_langstring必須target_langstring必須countinteger | null任意
レスポンス
200 リスト(1イベントにつき1単語)
ストリームイベント text/event-stream
15 秒ごとに keepalive コメントを送信します。
-
startedVocabStarted -
metaVocabMeta必須levelinteger必須source_langstring必須target_langstring必須frameworkstring必須countinteger必須ai_generatedboolean必須
-
itemVocabItem -
wordstring必須pronunciationstring | null任意readingstring | null任意translationstring必須exampleVocabExample | null任意sentencestring必須translationstring必須
image_urlstring | null任意
-
doneDone ストリームを終了 -
errorStreamError ストリームを終了 -
200 レスポンスの中で届きます。ステータス行はすでに送信済みのため、ストリーム開始後の失敗はこのイベントとして通知されます。
codestring必須messagestring必須plan_idstring | null任意
エラー
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必須
例
ライブラリを使いたい場合は、ライブラリのセクションをご覧ください。
ストリームの例
event: started
data: {"meta":{"level":2,"source_lang":"en","target_lang":"zh","framework":"HSK","count":2,"ai_generated":true}}
event: item
data: {"word":"你好","pronunciation":"nǐ hǎo","translation":"hello","example":{"sentence":"你好,我叫小明。","translation":"Hello, my name is Xiaoming."}}
event: item
data: {"word":"谢谢","pronunciation":"xiè xie","translation":"thank you"}
event: done
data: {}翻訳と英語版リファレンスの内容が異なる場合は、英語版リファレンスが正しいものとします。