イベントを送信

パラメーター

Lingara-Versionheaderstring任意

このリクエストに応答する API バージョン。指定がない場合、アクセストークンはそのクライアントに固定されたバージョンを、トークンのないリクエストは現行バージョンを受け取ります。開発中のバージョンには、ここで指定した場合にのみアクセスできます。不明なバージョンにはコード api_version_unknown とともに 400 を返します。GET /v1/versions でバージョンを一覧できます。

Idempotency-Keyheaderstring必須

イベントごとに選び、再試行時にも同じものを送る値です。UUID など、表示可能な ASCII 文字 1〜255 文字で指定します。同じキーでの再試行には最初の応答が返され、本文が異なっていても再度課金されません。有効なキーがない場合、リクエストはコード idempotency_key_required とともに 400 を返します。

リクエスト本文 application/json

typestring必須

dataWorldPracticeRequested必須

topicstring必須

source_langstring必須

target_langstring必須

levelinteger必須

tagsarray of string任意

generateboolean | null任意

レスポンス

202 イベントを記録しました

idstring必須

typestring必須

created_atstring必須

reactionReactionReport | null任意

statusReactionStatus必須

plan_idstring | null任意

plan_statusPlanStatus | null任意

イベントが受け付けられた時点のプランの状態です。lesson_plan.ready または lesson_plan.failed が届くことを約束するのは generating だけです。それ以外の値はライブラリから提供されたプランで、GET /v1/lesson-plans/{id} ですぐに読み取れます。

codestring | null任意

errorstring | 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必須

例

curl -X POST "https://api.getlingara.com/v1/events" \
  -H "Authorization: Bearer $LINGARA_TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type":"world.context_changed","data":{"scene":"A night market in Taipei, just after rain","npc":{"name":"Auntie Lin","persona":"a street-food vendor who likes to haggle"},"source_lang":"en","target_lang":"zh","level":3,"tags":["market","food","chapter-2"],"generate":true}}'

ライブラリを使いたい場合は、ライブラリのセクションをご覧ください。