ページの一覧

ドキュメント

API キーの作成と取り消し

自社のサーバーから voicast の API を呼び出すための API キーを、管理画面で環境ごとに作成・取り消しする手順。

Markdown で見る

API キーは、自社のサーバーから voicast の API(https://api.voicast.jp/v1)を呼び出すためのキーです。環境ごとに分かれていて、本番環境のキーは vk_live_、テスト環境のキーは vk_test_ で始まります。

API キーの管理は、管理者以上のロールで操作します。ほかのロールでは、左のメニューに[API キー]が表示されません。

API キーを作成する#

  1. キーを使う環境(本番環境かテスト環境)を開きます。
  2. 左のメニューの[API キー]で[+ API キーを作成]を押します。
  3. [名前]に、どこで使うキーか分かる名前(例: 本番サーバー。100 文字以内)を入力して、[作成]を押します。
  4. 表示されたキーを[コピー]して、安全な場所に保管します。

キーは作成したときに 1 回だけ表示されます。閉じると二度と表示できません。作成の画面の[次の手順]に、Node.js の SDK のインストールのコマンドと、API の URL が出ます。

  • API キーはサーバーだけに保存し、ブラウザーやアプリには渡さないでください。
  • 一覧には、キーの先頭・最終使用・作成日が出ます。

最初の会話までの手順ははじめかた、API の一覧は API リファレンスを参照してください。

API キーを取り消す#

キーが漏れた可能性があるときや、使わなくなったときは取り消します。

  1. [API キー]の一覧で、キーの[取り消す]を押します。
  2. 確認の画面で[取り消す]を押します。

取り消したキーを使う呼び出しは、すぐに失敗します。元に戻せません。キーを入れ替えるときは、先に新しいキーを作成してサーバーの設定を変えてから、古いキーを取り消してください。

MCP から使うとき#

Claude などの MCP のクライアントから voicast を操作するときは、API キーは要りません。ログインして許可します(MCP)。許可したアプリはアカウントの設定で取り消せます。