Kotoba APIリファレンス

Version: 0.0.1

このAPIリファレンスでは、Kotoba TechnologiesのREST APIおよびRealtime APIの使用方法について説明します。

認証

APIを利用するには、管理画面でユーザー登録を行い、APIキーを取得してください。

APIキーは秘密情報です！ GitHubやクライアント側のコード（ブラウザ、アプリ）で公開したり共有したりしないでください。サーバー側の環境変数またはキー管理サービスから安全に読み込んでください。

APIキーの流出が疑われたら

管理画面からAPIキーの即時無効化・有効期限を定めての無効化が可能です。同時に新規発行されるAPIキーをご利用ください。

APIキーは、HTTP Bearer認証（例：クロスオリジンリクエスト）の値として認証に使用します。

すべての API リクエストはHTTPS経由で行う必要があります。

curl https://api.kotobatech.ai/v1/realtime/transcription_sessions \
  -H "Authorization: Bearer $KOTOBA_API_KEY"

※現在は HTTP Basic 認証のユーザー名として（パスワードは空文字列）も認証を受け付けています。

curl -u $KOTOBA_API_KEY: https://api.kotobatech.ai/v1/realtime/transcription_sessions

info

Realtime APIに関しては別途制限がございます。詳しくはこちら。

過負荷による障害の防止を目的として、 1アカウント(=API key)ごとに流速 30 [request/sec] 程度のRate Limitを設けております。

リクエストが制限された場合、ステータス429のError JSONが返却されます。

制限の内部的な計算方式や詳細はアクセス状況に応じて変化するため、お問い合わせいただきましてもお答えいたしかねる点をご了承ください。

POSTメソッドでは Content-Type: application/json ヘッダーに準拠したボディで送信ください（ヘッダーの有無は自由です）。

GET、DELETEメソッドの引数はクエリーパラメータを利用します。

レスポンスは正常・異常とも全てUTF-8のJSON形式(Content-Type: application/json; charset=utf-8)で返されます。

日次に関するデータは基本的にUNIXタイムスタンプで表示されます。

こちらでOpenAPI仕様書を公開しておりますので、 Realtime API以外のAPIに関してはprismなどでlocalhostにmockサーバーを構築いただけます。