Logo

包括的な開発者ガイドとベストプラクティスで、すばやく開発を始められます。

全体像

コアコンセプト

API 全体の形を説明します。2 種類のエンドポイント(認証不要の参照系と、キーが必要な業務系)、共通のレスポンス構造、そして繰り返し登場する各種上限。

2 種類のエンドポイント

パス先頭で認証タイプが分かるため、URL を見るだけでキーの要否が判別できます。

公開エンドポイント(プレフィックスなし)

キー不要。連携前にサポート言語や利用可能モデルなどを確認するためのエンドポイントです。ブラウザから直接呼んでも問題ありません。

  • GET /translations/languages — 翻訳モジュールでサポートする言語一覧。
  • GET /translations/models — 翻訳モジュールで利用可能なモデル一覧。
  • GET /audio/languages — 音声認識モジュールでサポートする言語一覧。

キー認証エンドポイント(/api/v1)

HTTP ヘッダーに X-API-Key を付与する必要があります。テキスト翻訳、音声認識、辞書管理など、コア業務操作を提供します。

  • POST /api/v1/translations/text — テキスト翻訳。ストリーミングはオプション。
  • POST /api/v1/audio/transcriptions — 音声認識。Base64 とファイルアップロードの両方に対応。
  • /api/v1/dictionaries/* — 辞書管理(用語集、強制置換辞書、一括操作)。
  • GET /api/v1/usage — 当期のアカウント層・キー層の使用率照会。クォータを消費しない。

API キーの入手方法

デベロッパーコンソールの「API キー」ページで作成します。キーの作成・失効はコンソール UI でのみ実行可能で、管理用の公開 API は提供していません。

共通レスポンス構造

成功時は data(ペイロード)と usage(使用量)が、失敗時は code / message / details / request_id を含む error オブジェクトが返ります。すべての呼び出しに request_id が付与され、問題報告時にサーバーログを特定できます。

繰り返し登場する上限

  • テキスト翻訳は 1 回あたり 5000 文字まで。超過すると 400 validation_error が返ります。
  • 音声認識の上限はアップロード方式で異なる:JSON(Base64)経路は raw 音声 ≤ 1 MB(超過は 413 audio_too_long)、multipart ファイルアップロードは ≤ 15 MB(超過は 413 file_too_large)。
  • 辞書の一括操作は 1 回あたり 250 件までです。

次に読む章

エラーコード一覧は「エラーハンドリング」、request_id の運用は「リクエスト識別子と障害報告」、ストリーミングのイベント構造は「SSE ストリーミング」を参照してください。