本文へスキップ
Hedy

Hedy API

エンドポイントURLとAPIキーの生成が表示されたAPIアクセスの設定画面

Hedy APIとは

Hedy APIを使うと、ミーティングデータ、文字起こし、要約、AIが生成したインサイトに、プログラムからアクセスできます。独自の連携を構築する場合も、ワークフローを自動化する場合も、Zapierなどのツールと接続する場合も、このAPIでHedyの機能をアプリの外へ広げられます。すべてのAPI機能には、クラウド同期を有効にしたProサブスクリプションが必要です。コードを書く代わりに、AIアシスタントにこのデータを対話的に扱わせたい場合は、MCPでHedyとAIアシスタントを接続することもできます。

APIを使い始める

  1. 設定を開き、自動化とデータタブに移動します

  2. APIアクセスセクションまでスクロールします

  3. 新しいAPIキーを生成をクリックします（Proサブスクリプションが必要です）

  4. APIキーをコピーして、安全に保管します。もう一度表示することはできません

  5. エンドポイントの詳細はSwaggerHubのAPIドキュメントをご覧ください。生のOpenAPI仕様はhttps://api.hedy.bot/docsから入手できます

セキュリティ上の注意：APIキーは、Hedyのデータへのフルアクセスを提供します。安全に管理し、公開したり、バージョン管理にコミットしたりしないでください。

リージョンごとのエンドポイントURL

Hedy APIは、ユーザーデータを適切な法域に保つために、2つのリージョンで動作しています。アカウントを作成したリージョンに対応するベースURLを使ってください。

  • 米国のアカウント：https://api.hedy.bot

  • EUのアカウント：https://eu-api.hedy.bot

どちらのリージョンも同じコードで動作し、同じエンドポイントを提供しており、機能の違いはありません。APIキーはアカウントのリージョンに紐づいているため、誤ったベースURLを呼び出すと認証に失敗します。アカウントのリージョンがわからない場合は、Hedyを開いて設定 → プライバシーとシステム → プライバシー設定に移動してください。旗のアイコンで、データの保管場所がわかります。

この記事の例は、https://api.hedy.botを使っています。アカウントがEUの場合は、すべてhttps://eu-api.hedy.botに置き換えてください。

APIでできること

Hedy APIは、ミーティングインテリジェンスへの包括的なアクセスを提供します。

  • セッション：ミーティングのセッションの一覧表示と取得。完全な文字起こし、AI要約、重要ポイントも含みます

  • ハイライト：ミーティングの重要な場面を、AIが生成したインサイト付きで取得します

  • トピック：トピックの作成、更新、削除と、カスタムコンテキストの指示を使ったセッションの整理

  • ToDo：すべてのセッションにまたがるアクションアイテムの取得と管理

  • セッションコンテキスト：Hedyがミーティングを分析する方法を指示する、再利用可能な指示の作成と管理

  • カスタム語彙：名前や専門用語の文字起こしの精度を高める、アカウントの語彙リストの読み取りと置き換え

  • Webhook：リアルタイムのイベント通知のためのWebhookエンドポイントを、APIで設定・管理

  • ユーザー情報：/meエンドポイントで、アカウントの詳細を取得します

APIが扱えるのは、すでに存在するセッションです。ライブセッションの開始や停止は、お使いの端末のHedyアプリで行われるため、APIではできません。同じ端末上のスクリプトや別のアプリからセッションを開始または終了するには、ほかのアプリからセッションを開始するをご覧ください。

認証

すべてのAPIリクエストには、APIキーによる認証が必要です。Authorizationヘッダーに含めてください。

Authorization: Bearer YOUR_API_KEY

Webhook

Webhookを設定すると、Hedyアカウントでイベントが発生したときに、リアルタイムの通知を受け取れます。

  1. APIアクセスセクションで、Webhookを管理をクリックします

  2. +ボタンをクリックして、新しいWebhookを追加します

  3. HTTPSのエンドポイントURLを入力します

  4. 受信したいイベントを選択します。

    • session.created - 新しいセッションが開始されたとき

    • session.ended - セッションの処理が完了したとき

    • session.exported - ユーザーがセッションを手動でエクスポートしたとき

    • highlight.created - 新しいハイライトが追加されたとき

    • todo.exported - セッションからToDoがエクスポートされたとき

    • suggestion.created - セッション中に、Hedyが自動提案を表示したとき

  5. Webhookを保存し、ペイロードの検証用に署名シークレットを控えておきます

APIを使って、Webhookをプログラムから管理することもできます。/webhooksエンドポイントに対して、GET、POST、DELETEを使います。アカウントごとに、最大50個のWebhookを持てます。

Webhookの署名検証

すべてのWebhook配信には、X-Hedy-Signatureヘッダーに署名が含まれており、Hedyから送信されたものであることを検証できます。署名は、リクエストボディの生データのHMAC-SHA256ハッシュで、Webhookの署名シークレットで署名されています。ペイロードを処理する前に、サーバー側で署名を検証して、真正性を確認してください。また、各配信には、イベントの種類（例：session.ended）を示すX-Hedy-Eventヘッダーも含まれます。

セッションコンテキスト

セッションコンテキストを使うと、Hedyがミーティングを分析する方法を伝える、再利用可能なカスタム指示のセットを作成できます。たとえば、アクションアイテムと顧客の反論に注目する「営業の通話」用のコンテキストや、ブロッカーと進捗を追跡する「スタンドアップミーティング」用のコンテキストを作成できます。

APIを使って、セッションコンテキストを管理できます。

  • GET /contexts - すべてのセッションコンテキストを一覧表示します

  • GET /contexts/{id} - IDで特定のコンテキストを取得します

  • POST /contexts - 新しいコンテキストを作成します（タイトルと内容）

  • PATCH /contexts/{id} - 既存のコンテキストを更新します

  • DELETE /contexts/{id} - コンテキストを削除します

コンテキストをデフォルトに設定すると、すべての新しいセッションに自動的に適用されます。無料プランのアカウントは、セッションコンテキストを1つまでに制限されています。

APIでトピックを管理する

トピックは、セッションをカテゴリに整理するのに役立ちます。APIは、トピックの完全な管理に対応しています。

  • GET /topics - すべてのトピックを、AIが生成したインサイトとセッション数とともに一覧表示します

  • GET /topics/{id} - 特定のトピックの詳細を取得します

  • POST /topics - 名前、説明、色、アイコン、デフォルトのセッションタイプを指定して、新しいトピックを作成します

  • PATCH /topics/{id} - トピックのプロパティ、カスタムコンテキスト、デフォルトのセッションタイプを更新します

  • DELETE /topics/{id} - トピックを削除します（セッションはリンクが解除されるだけで、削除されません）

  • GET /topics/{id}/sessions - トピック内のすべてのセッションを一覧表示します

  • PATCH /sessions/{id} - {"topicId": "<topic id>"}でセッションをトピックに移動し、{"topicId": null}でトピックから外します。サポートされているフィールドはtopicIdだけで、Hedyは影響を受けるトピックのAI概要を更新します。

クラウド同期をオフにして取り込んだセッションは移動できません（409 session_not_synced）。移動先のトピックは存在している必要があり、削除処理の途中であってはなりません。

トピックには、そのトピックに割り当てられたセッションをHedyがどう分析するかを導く、カスタム指示（最大20,000文字）を含むtopicContextフィールドを含められます。この指示は、そのトピックの下で開始したセッションに自動的に付与され、セッション中のライブ提案にも適用されるため、APIでトピックを準備しておくだけで、セッションの準備にもなります。

トピックは、dominantSessionTypeフィールドも受け付けます。これは、そのトピックの下で開始したセッションが使用するセッションタイプを設定します。プログラムでトピックを作成するときに、すべてがデフォルトのタイプになってしまうのを避けたい場合に便利です。このフィールドは、派生した統計値も兼ねています。トピックにセッションができると、実際に使ったタイプからHedyが再計算するため、書き込んだ値は恒久的な設定ではなく、出発点として機能します。すでにセッションがあるトピックに設定した場合は、次のセッションに対する一度限りの上書きとして機能します。受け付けるセッションタイプの値は、APIリファレンスに記載されています。

カスタム語彙

カスタム語彙は、あなたの仕事に固有の名前、略語、専門用語をHedyに教えて、文字起こしの精度を高めます。リストはアカウントに保存され、すべてのセッションに適用されます。

  • GET /vocabulary - 現在の用語リストと、語彙が有効かどうかを取得します

  • PUT /vocabulary - 用語リスト全体を置き換えます

PUTはリストに追加するのではなく、リスト全体を置き換えるため、含めなかった保存済みの用語は削除されます。送信できるのは最大100語で、それぞれ2〜50文字です。用語は一意である必要があり（比較では大文字と小文字を区別しません）、山括弧、波括弧、角括弧、バックスラッシュ、パイプ、バッククォート、チルダを含められません。

enabledフラグは、読み取りも書き込みもできます。用語を置き換えるときに省略すると、保存されている値はそのままになります。語彙の更新を自動化する場合に重要です。先にフラグを読み取れば、書き込む用語が、語彙機能がオフのアカウントで使われないまま放置されるのではなく、実際に使われるかどうかがわかります。

1回の呼び出しでリスト全体を入れ替えられるため、長い統合リストをひとつ維持する代わりに、ミーティングごとに必要な名前や用語に合わせて、ミーティングの前に語彙を書き換えることもできます。

よくある活用例

  • プロジェクト管理との連携：ミーティングのアクションアイテムから、PMツールにタスクを自動的に作成します

  • ナレッジマネジメント：ミーティングの内容を、社内のナレッジベースにインデックス化します

  • CRMとの連携：ミーティングのインサイトで、顧客レコードを更新します

  • 分析ダッシュボード：ミーティングのパターンや生産性に関する、独自のレポートを作成します

  • ワークフローの自動化：ミーティングの内容や完了をきっかけに、アクションを実行します

  • Zapierとの連携：Zapierを使って、Hedyを何千ものアプリに接続します（Zapier互換のフラットな配列レスポンスを得るには、エンドポイントに?format=zapierを追加します）

APIの制限とベストプラクティス

  • レート制限：APIキーごとに、1分あたり200リクエスト

  • ページネーション：limitパラメータ（デフォルト50、最大100）とafterカーソルパラメータを使って、結果をページ送りします

  • 可能な限りレスポンスをキャッシュして、API呼び出しを減らします

  • エラーは、指数バックオフで適切に処理します

  • リアルタイムの更新には、ポーリングではなくWebhookを使います

ToDoの自動エクスポート

ToDoの自動エクスポートを有効にすると、アクションアイテムが、連携したシステムに送信されます。

  1. APIアクセスセクションで、ToDo の自動エクスポートをオンにします

  2. ToDoが、設定済みのWebhookエンドポイントに自動的に送信されます

  3. 各ToDoには、コンテキスト、担当者の提案、ミーティングへの参照が含まれます

コードの例

最近のセッションを取得する簡単な例です。

curl -X GET "https://api.hedy.bot/sessions?limit=10" \  -H "Authorization: Bearer YOUR_API_KEY"

その他の例とエンドポイントの完全なリファレンスは、APIドキュメントをご覧ください。

トラブルシューティング

401 Unauthorizedエラー

  • APIキーが正しく、正しい形式であることを確認します

  • 有効なProサブスクリプションがあることを確認します

  • アカウントでクラウド同期が有効になっていることを確認します

  • APIキーが再生成されていないことを確認します（古いキーは無効になります）

レスポンスが空、またはデータが足りない

  • クラウド同期が有効であることを確認します。APIがアクセスするのは、クラウド同期されたデータだけです

  • セッションのあと、データが同期されるまで数分待ちます

  • 日付フィルターとページネーションのパラメータを確認します

  • データの種類に合った正しいエンドポイントを使っていることを確認します

Webhookがイベントを受信しない

  • エンドポイントのURLがHTTPSであることを確認します（必須です）

  • サーバーが200 OKのステータスで応答することを確認します

  • 署名検証を実装している場合は、X-Hedy-Signatureヘッダーを確認します

  • 「Webhookをテスト」ボタンでWebhookをテストします

  • ファイアウォールのルールが、Hedyのサーバーをブロックしていないか確認します

レート制限を超過した

  • キャッシュを実装して、不要なAPI呼び出しを減らします

  • リアルタイムの更新には、ポーリングではなくWebhookを使います

  • 可能な限り、操作をまとめて実行します

  • より高い上限が必要な場合は、サポートにお問い合わせください

プロのヒント：リアルタイムの更新には、ポーリングではなくWebhookを使ってください。そのほうが効率的で、データが変わったときに即座に通知を受け取れます。

プライバシーとセキュリティ

データのセキュリティは、私たちの最優先事項です。

  • すべてのAPI通信は、HTTPS暗号化を使用します

  • APIキーは、いつでも再生成できます（古いキーは無効になります）

  • Webhookのペイロードは、検証のためにHMAC-SHA256で署名されます

  • データには、有効な認証がある場合のみアクセスできます

  • すべてのエンドポイントで、厳格なセキュリティヘッダーを適用します

サポート

APIに関するご質問は、次をご利用ください。

関連記事

音声・動画ファイルのインポート オンライン動画のインポート 既存の文字起こしをHedyにインポートする

この記事で疑問は解決しましたか？