メインコンテンツへスキップ
APIキーを使用すると、外部のシステムやスクリプトからワークスペースのリソースにプログラム的にアクセスできます。CI/CDパイプラインや自社システムとの連携に活用してください。

APIキーの作成

  1. ダッシュボードの 設定 > APIキー を開く
  2. 「APIキーを作成」ボタンをクリック
  3. キーの名前を入力する(例: CI/CDパイプライン)
  4. 必要なスコープを選択する
  5. 「APIキーを作成」をクリック
作成後に表示されるキー(ws_sk_...)をコピーしてください。**キーは作成時に一度だけ表示されます。**再表示はできないため、安全な場所に保管してください。

スコープ

APIキーには、アクセスできるリソースと操作を制限するスコープを設定します。write スコープには read 権限が含まれます。
リソーススコープ説明
エージェントagents:read / agents:writeエージェントの取得・作成・更新
セッションsessions:read / sessions:writeセッションの取得・作成
ピープルpeople:read / people:writeピープルの取得・作成・更新
ナレッジknowledges:read / knowledges:writeナレッジの取得・作成・更新
ポータルportals:read / portals:writeポータルの取得・作成・更新
インテグレーションintegrations:read / integrations:writeインテグレーションの取得・設定
メトリクスmetrics:readメトリクスの取得(読み取り専用)

APIキーの使用

リクエストの Authorization ヘッダーに Bearer トークンとしてキーを指定します。
curl -H "Authorization: Bearer ws_sk_xxxxxxxxxxxx" \
  https://api.turnint.io/v1/api-keys

APIキーの無効化

不要になったキーや漏洩の可能性があるキーは速やかに無効化してください。
  1. ダッシュボードの 設定 > APIキー を開く
  2. 対象のキーの行にあるメニューから「無効化」を選択する
  3. 確認ダイアログで操作を承認する
無効化されたキーを使用したリクエストは即座に拒否されます。

注意事項

  • APIキーの管理はワークスペース管理者のみ利用できます。
  • キーは作成時に一度だけ表示されます。紛失した場合は新しいキーを作成してください。
  • キーには有効期限を設定できます。期限切れのキーは自動的に無効になります。
  • 無効化したキーを再有効化することはできません。