YOMEL Public API(api_v2)
    • YOMEL API
    • Webhook
      • リアルタイム書き起こし発生時
        GET
      • 会話終了時
        GET
      • 話者分離完了時
        GET
      • 要約処理完了時
        GET
    • RestAPI
      • ユーザーアカウント一覧の取得
        GET
      • ユーザーアカウントの取得
        GET
      • ログ検索
        GET
      • ログ検索（キーワード）
        GET
      • 要約結果の取得
        GET
      • ログ詳細情報の取得
        GET
      • 話者分離結果の取得
        GET
      • グループ一覧の取得
        GET
      • グループの取得
        GET

    YOMEL API

    YOMEL APIではWebhook（Push型）とRestAPI形式（Pull型）のAPIを提供しています。
    それぞれ、ログの取得や要約結果の取得などが可能です。

    利用について#

    Webhook#

    YOMELのスペース設定内の API設定 画面からWebhookキーを作成し、送信先エンドポイントURL・イベント・セキュリティトークンを設定します。
    Webhookはキー単位で管理され、対象グループ管理者による承認が完了したものだけが送信対象になります。
    YOMELサーバーからアクセスできないURLやプライベートネットワークアドレスでは利用できません。外部からアクセス可能なエンドポイントURLを用意してください。
    Webhookが発動されるイベントは次の通りです。
    レスポンスパラメータ：type によってどのイベントが発動したか判定できます。
    発動タイミングイベントタイプ（レスポンスパラメータ：type ）プロセスタイプ（レスポンスパラメータ：process_type）送信オブジェクト
    リアルタイム書き起こし発生時UserAccountLogRealtimecreated吹き出し単位のリアルタイム書き起こしテキスト
    会議終了時UserAccountLogupdated書き起こし結果テキスト（全文）
    話者分離完了時UserAccountLogDiarizationupdated話者分離結果テキスト
    要約処理完了時UserAccountLogSummaryGPT3updated要約結果テキスト
    security_token を設定したWebhookでは、X-Webhook-Timestamp、X-Webhook-Nonce、X-Webhook-Signature ヘッダーが付与されます。
    Webhook受信側では、設定した security_token を使って、{X-Webhook-Timestamp}.{X-Webhook-Nonce}.{リクエストボディ(JSON文字列)} を HMAC-SHA256 で計算し、X-Webhook-Signature の値（v1= を除いた値）と一致するかを確認してください。

    RestAPI#

    利用にはAPI Keyが必要です。API Keyはスペース管理者がスペース設定内の API設定 画面から発行します。
    発行したAPI Keyは X-API-KEY ヘッダーに設定して利用します。API Keyは発行時にのみ表示され、再表示はできません。
    API Keyには有効期限を設定する必要があります。有効期限は発行後に変更できないため、継続して利用する場合は新しいAPI Keyを作成して切り替える必要があります。

    YOMELのログの基本構造#

    YOMELのログシステムは、会話データ、話者情報、AI要約結果などの情報を管理するための構造を持っています。
    YOMELの機能についてはYOMEL サポートページもご覧ください。

    スペース・グループ・ログの関係について#

    YOMELでは「スペース」という単位で利用環境が発行されます。
    「スペース」の中に複数「グループ」を作成することができ、その中で「ログ」を管理します。
    それぞれ下記のID名で管理されます
    スペースのID：clientまたはid
    グループのID：groupまたは id
    ログのID：user_account_logまたはid
    API Keyごとに参照可能なグループを設定します。
    実際にRestAPIやWebhookで参照できるのは、その中でもグループ管理者によって承認されたグループだけです。

    主要コンポーネント#

    ログ#

    会話や会議の記録を一つの単位として管理します。
    含まれる内容
    会話文
    メタデータ（作成者、作成日時など）
    要約や話者分離結果を取得するためのログID
    所属するスペースやグループのID

    グループ#

    グループは複数のログを持ちます。
    含まれる内容
    グループ名
    メタデータ（作成者、作成日時、アーカイブ状態、プライベートモード状態など）
    所属するスペースのID等

    注意事項#

    APIで取得可能なログ・グループ・ユーザー・タグは、API Keyに紐づくグループ管理者の承認済みグループの範囲に限定されます。
    APIで取得可能なデータのうち、プライベートグループに所属するデータは取得できません。
    シークレットグループおよびアーカイブ済みグループに所属するデータは、API Keyの参照範囲に含まれ、かつ承認されている場合は取得対象になります。

    YOMELでの処理フローについて#

    音声認識にはリアルタイム型とファイルインポート型があります。
    リアルタイム型では吹き出し単位での音声認識結果の取得が可能です。
    書き起こしが完了すると、話者分離、要約までの一連の処理が実行されます。

    1. リアルタイム書き起こし#

    会話開始時点から、音声認識による書き起こしがリアルタイムで実行されます。書き起こし結果は、発話の区切り（吹き出し）単位で生成されます。

    2. 会話の終了またはファイルインポート完了#

    会話終了時に、それまでの書き起こし結果が一つのログとして保存されます。ログには会話の開始・終了時刻、参加者情報などのメタデータが含まれます。

    3. 後処理（オプショナル）#

    会話終了後、以下の処理が必要に応じて実行されます：

    話者分離処理#

    音声データから話者を識別し、発話者ごとの分類を行います。
    処理完了後、結果が該当する会話ログに関連付けられます。

    要約処理#

    書き起こしテキストから重要なポイントを抽出し、要約を生成します。
    処理完了後、結果が該当する会話ログに関連付けられます。
    YOMELの機能としてのAI要約の詳細についてはAI要約設定（記録内容をAIで要約する）のページもご覧ください。

    注意事項#

    話者分離処理および要約処理はオプショナル機能であり、処理結果が存在しない場合があります。
    システム設定や利用プランによって、これらの処理が実行されない場合があります。
    更新日時 2026-04-16 07:29:15
    次へ
    Webhook
    Built with