API

APIを使うと、自社のシステムやスクリプトから、会議のノート、文字起こし、AIで整形されたノートをプログラムで取得できます。APIキーを作成するときに、そのキーがどの範囲のノートを読み取れるかを選ぶ仕組みです。

チームプラン Enterpriseプラン

#何を作れるか

• 独自のAIエージェント — 商談の内容を横断して傾向を集計する、プロダクトへの要望に繰り返し現れるテーマを抽出する、社内の他のデータと会議の文脈を組み合わせて分析する、といった処理を自前で組めます。
• 社内のナレッジベース・Wiki — 会議ノートを Notion や Confluence、社内Wikiへ流し込み、検索できる状態で最新に保ちます。
• タスクとフォローアップの自動化 — ノートから決定事項やタスクを抽出し、Linear、Jira、Todoist などのタスク管理ツールへ自動で登録します。
• CRMへの反映とレポート — 会議の要約やタスクをCRMのレコード、ダッシュボード、社内レポートの処理へ送ります。

#利用できるプラン

APIキーを作成できるのは、チームプランまたはEnterpriseプランのワークスペースメンバーです。

Enterpriseプランでは、設定 → ワークスペース → 一般 → メンバーのAPIアクセス（Settings → Workspace → General → API access for members）で、管理者がメンバーに許可するアクセス範囲を制御できます。

#アクセス範囲（スコープ）

APIキーには、読み取れるノートの範囲を指定します。

Pulseのノートは初期状態では非公開です。公開ノートのスコープで読み取れるようにするには、ワークスペースの全員が閲覧できるフォルダ（チームスペース内のフォルダなど）にノートを置く必要があります。プライベートフォルダに置いたままのノートは、もともとそのノートにアクセスできる利用者の個人のノートのスコープからのみ読み取れます。

#個人のAPIキーを作成する

1. 1

   設定でAPIキーの画面を開く

   デスクトップアプリで 設定 → コネクタ → APIキー（Settings → Connectors → API keys）を開きます。

2. 2

   新しいキーを作成する

   「新しいキーを作成」（Create new key）をクリックし、そのキーに含めるアクセス範囲を選びます。

3. 3

   キーを生成してコピーする

   「APIキーを生成」（Generate API Key）をクリックし、表示されたAPIキーをコピーして、利用するシステムに登録します。

図画面キャプチャ: 設定 > コネクタ > APIキー

発行済みのキーの一覧（名前、アクセス範囲、作成日、失効ボタン）と、新しいキーを作成するボタンが並んでいる画面。

Enterpriseプランでは、管理者が有効にしていないアクセス範囲を含むキーは作成できません。作成画面で選べるアクセス範囲が表示されない場合は、ワークスペースの管理者に確認してください。

#管理者がアクセス範囲を制御する（Enterpriseプラン）

1. 設定 → ワークスペース → 一般 を開きます。
2. メンバーのAPIアクセス（API access for members）を探します。
3. 「管理」（Manage）をクリックします。
4. メンバーが使えるアクセス範囲を選びます。

個人のノートのみ、公開ノートのみ、両方、どちらも許可しない、の4通りから選べます。どちらも許可しない設定にすると、メンバーは新しいAPIキーを作成できません。

#ワークスペースのAPIキー

ワークスペースのAPIキーは管理者が管理するキーで、個人ではなくワークスペースに属します。チームプランとEnterpriseプランで利用できます。個人のAPIキーと違って有効期限がなく、特定の個人のアカウントに紐づかないため、作成した管理者が退職しても動作し続けます。基幹システムとの常時連携のように、担当者の異動で止まっては困る用途に向いています。

ワークスペースのAPIキーが読み取れるのは次の範囲です。

• 公開ノート — ワークスペースの全員が閲覧できるノート（チームスペース内のノートなど）。管理者がワークスペースの公開フォルダを許可する設定をオフにしている場合、これらのノートはAPIに公開されません。
• APIアクセスを有効にしたスペースのノート — スペースの作成時、または後から設定 → スペースで「APIからのアクセスを許可」（Allow API access）をオンにすると、そのスペースのノートをワークスペースのAPIキーから読み取れるようになります。対象にはそのスペース配下のフォルダとサブフォルダも含まれます。

このいずれにも当てはまらないプライベートなノートやフォルダは、ワークスペースのAPIキーからは読み取れません。

「APIからのアクセスを許可」は、新しいスペースを作成したときに初期状態で有効になっています。そのスペースのノートをワークスペースのAPIキーから読み取らせたくない場合は、作成時にオフにするか、あとから設定 → スペースでオフにしてください。

ワークスペースのAPIキーを作成・管理できるのはワークスペースの管理者だけです。作成の手順は次のとおりです。

1. 1

   設定でワークスペースAPIキーの画面を開く

   デスクトップアプリで 設定 → コネクタ → ワークスペースAPIキー（Settings → Connectors → Workspace API keys）を開きます。

2. 2

   新しいキーを作成する

   「新しいキーを作成」（Create new key）をクリックします。

3. 3

   キーをコピーして登録する

   表示されたAPIキーをコピーし、利用するシステムに登録します。

#キーを失効させる

個人のAPIキーとワークスペースのAPIキーは別のページで管理されているため、それぞれのページから失効させます。

個人のAPIキーを失効させる

1. 設定 → コネクタ → APIキー を開きます。
2. 失効させたいキーを探し、「失効」（Revoke）をクリックします。
3. 確認ダイアログで実行します。

ワークスペースのAPIキーを失効させる（管理者のみ）

1. 設定 → コネクタ → ワークスペースAPIキー を開きます。
2. 失効させたいキーを探し、「失効」（Revoke）をクリックします。
3. 確認ダイアログで実行します。

#APIリファレンス

エンドポイント、認証方式、リクエストとレスポンスの例をまとめたリファレンスは、開発者向けドキュメントで公開しています。APIおよび外部連携を利用する際の条件はAPI・プラットフォーム利用規約を確認してください。

#取り扱うデータについて

APIで取得できるのは会議のノートと文字起こしであり、参加者の氏名、メールアドレス、発言内容といった個人情報を含むのが通常です。取得したデータを自社システムに保存する場合、その保存先と保存期間、アクセスできる担当者の範囲を、自社の個人情報の取扱いに関する規程に沿って設計してください。

取得したデータをさらに別の事業者へ渡す場合の整理については、連携機能の一覧を確認してください。

#よくある質問

#関連記事