認証

Squadbase API へのリクエストは、x-api-key ヘッダーに渡す APIキー で認証します。最も一般的な用途は、自社のシステムから API を呼び出すこと、たとえば Zapier や n8n などのワークフローツール・cron・社内ツールから エージェントをトリガーする ケースです。

APIキーの作成

Squadbaseのアカウント設定からAPIキーを作成することができます。APIキーは使用することができるチームやプロジェクトを細かく制限することができます。

1. Portal画面の左サイドバー最下部のアカウントアイコンをクリックし、APIキーを開きます。
2. +Createボタンをクリックし、APIキーの名前を設定します。
3. アクセスを許可するチーム・プロジェクトを選択しAPIキーを作成をクリックすると、APIキーが作成されます。

認可ルール

• キーの所有者は、対象リソースが属するプロジェクトのViewer以外のメンバーである必要があります。
• キーが対象プロジェクト / チームにスコープされていない場合は 401 を返します。
• IP制限が適用されます。APIキー単位のsourceIp allowlistと、チームのIP制限の両方が、導出されたチームに対して適用されます。

APIキーの使用

HTTPリクエストの x-api-key ヘッダーにキーを指定します。たとえば、エージェントをトリガーする場合は次のようになります。

curl -X POST 'https://api.squadbase.dev/v0/agent/<AGENT_ID>/trigger' \
  -H 'x-api-key: <YOUR_API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{"message":"今週のサインアップ動向を分析して"}'

利用可能なすべてのエンドポイントは API概要 を参照してください。