コンテンツへ移動

ScribeMD API

ScribeMDを貴社の製品に組み込む

REST API、モバイルSDK、MCPサーバーを使って、自社システムから診察の録音を送信し、完成したカルテを取得し、組織の診察記録をエクスポートできます。

実現できること

診察全体をひとつのAPIで

  • 診察の作成

    臨床医に代わって録音をアップロードすると、ScribeMDが文字起こしを行い、その臨床医のテンプレートでカルテを作成します。

  • カルテの取得と編集

    カルテが完成するまで診察をポーリングし、MarkdownまたはJSON形式で取得、または更新できます。

  • 診察記録のエクスポート

    組織の診察記録を期間と診療科で絞り込み、ページ単位で一覧取得します。

  • EHRへの組み込み

    EHRから独自の項目付きで録音を開始し、完成したカルテを取り込みます。

認証

2種類の認証情報

各エンドポイントはいずれか一方を使用します。どちらを使うかは下記のリファレンスに記載しています。

  • 組織APIキー

    組織に代わって行うサーバー間の呼び出しに使用します。X-Api-Keyヘッダー、またはAuthorization: Bearerで送信してください。

    組織の管理者、または管理者から開発者権限を付与されたメンバーが、Settings > API Keysでキーを作成できます。キーは一度しか表示されません。サーバー上で保管し、ブラウザやアプリには決して含めないでください。

  • ユーザーアクセストークン

    ScribeMDアプリやモバイルSDKと同様に、サインイン中の臨床医1名に代わって行う呼び出しに使用します。Authorization: Bearer、またはaccess_tokenパラメーターで送信してください。

  • OAuthアクセストークン

    MCPサーバー用:Authorization: Bearerで送信するOAuth 2.1アクセストークンです。

クイックスタート

録音からカルテまで

  1. 録音を送信する

    リクエスト
    curl -X POST https://api.scribemd.ai/api/v1/visits \
      -H "X-Api-Key: $SCRIBEMD_API_KEY" \
      -F "audio_file=@visit.m4a" \
      -F "user_email=dr.rivera@example.com" \
      -F "language=en-US"
    レスポンス
    HTTP/1.1 201 Created
    {
      "encounter_uuid": "1bc91eb0-ca16-40a5-87c5-ccc7b6cb4f14"
    }
  2. 完成したカルテを取得する

    リクエスト
    curl "https://api.scribemd.ai/api/v1/encounters/retrieve?uuid=1bc91eb0-ca16-40a5-87c5-ccc7b6cb4f14" \
      -H "Authorization: Bearer $SCRIBEMD_USER_TOKEN"
    レスポンス
    {
      "success": true,
      "uuid": "1bc91eb0-ca16-40a5-87c5-ccc7b6cb4f14",
      "summary_status": "running",
      "transcript_status": "finished",
      "ready": false,
      "duration": 642
    }

リファレンス

エンドポイント

公開パートナー向けエンドポイントと、その認証情報およびパラメーター。

POST/api/v1/visits

所属する臨床医の音声録音から診察を作成します(user_emailで指定。省略時はキーの作成者)。

認証
APIキー
パラメーター
  • audio_filefile必須
  • user_emailstring任意
  • template_idinteger任意
  • patient_first_namestring任意
  • patient_last_namestring任意
  • languagestring任意
  • timestampstring任意
  • patient_idstring任意
  • medical_recordstring任意
  • contextstring任意
  • webhook_urlstring任意
リクエスト
curl -X POST https://api.scribemd.ai/api/v1/visits \
  -H "X-Api-Key: $SCRIBEMD_API_KEY" \
  -F "audio_file=@visit.m4a" \
  -F "user_email=dr.rivera@example.com" \
  -F "language=en-US"
レスポンス
HTTP/1.1 201 Created
{
  "encounter_uuid": "1bc91eb0-ca16-40a5-87c5-ccc7b6cb4f14"
}

GET/api/v1/organization_encounters

組織の診察記録を新しい順に1ページ20件で、日付と診療科で絞り込んで一覧取得します。

認証
APIキー
パラメーター
  • start_datedate任意
  • end_datedate任意
  • department_idsstring任意
  • pageinteger任意
リクエスト
curl "https://api.scribemd.ai/api/v1/organization_encounters?start_date=2026-01-01&end_date=2026-01-31&page=1" \
  -H "X-Api-Key: $SCRIBEMD_API_KEY"
レスポンス
{
  "encounters": [
    {
      "id": 12345,
      "uuid": "1bc91eb0-ca16-40a5-87c5-ccc7b6cb4f14",
      "title": "Follow-up visit",
      "status": "finished",
      "summary_status": "finished",
      "note_format": "markdown",
      "markdown_content": "#### Chief Complaint\n..."
    }
  ],
  "pagination": { "count": 1, "page": 1, "limit": 20 }
}

POST/api/v1/integrations/recordings

臨床医のためにEHR連携の録音を開始し、録音ウィジェット用の短期トークンを返します。

認証
APIキー
パラメーター
  • user_emailstring必須
  • settingsobject任意
リクエスト
curl -X POST https://api.scribemd.ai/api/v1/integrations/recordings \
  -H "Authorization: Bearer $SCRIBEMD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "user_email": "dr.rivera@example.com", "settings": { "defaultLanguage": "en-US" } }'
レスポンス
HTTP/1.1 201 Created
{
  "uuid": "1bc91eb0-ca16-40a5-87c5-ccc7b6cb4f14",
  "recordId": null,
  "token": "fake-short-lived-token",
  "expiresAt": "2026-01-15T10:30:00Z",
  "settings": { "defaultLanguage": "en-US" }
}

GET/api/v1/integrations/recordings/:uuid

連携録音のステータスを取得し、完了後はカルテの項目と文字起こしを返します。

認証
APIキー
パラメーター
  • uuidstring必須
リクエスト
curl https://api.scribemd.ai/api/v1/integrations/recordings/1bc91eb0-ca16-40a5-87c5-ccc7b6cb4f14 \
  -H "X-Api-Key: $SCRIBEMD_API_KEY"
レスポンス
{
  "uuid": "1bc91eb0-ca16-40a5-87c5-ccc7b6cb4f14",
  "recordId": null,
  "patientId": null,
  "status": "waiting",
  "reviewedAt": null,
  "settings": {}
}

GET/api/v1/encounters/retrieve

サインイン中の臨床医の診察を、uuid、EHRの診察IDまたは予約IDで取得します。カルテはreadyがtrueになると取得できます。

認証
ユーザートークン
パラメーター
  • uuidstring任意
  • ehr_encounter_idstring任意
  • ehr_appointment_idstring任意
リクエスト
curl "https://api.scribemd.ai/api/v1/encounters/retrieve?uuid=1bc91eb0-ca16-40a5-87c5-ccc7b6cb4f14" \
  -H "Authorization: Bearer $SCRIBEMD_USER_TOKEN"
レスポンス
{
  "success": true,
  "uuid": "1bc91eb0-ca16-40a5-87c5-ccc7b6cb4f14",
  "summary_status": "running",
  "transcript_status": "finished",
  "ready": false,
  "duration": 642
}

POST/api/v1/encounters/:id/resume_visit

診察の録音を、関連付けられた新しい診察として続行します。

認証
ユーザートークン
パラメーター
  • idinteger必須

POST/api/v1/encounters/:id/update_notes

診察のカルテを置き換えます(JSON形式のカルテ、またはMarkdown形式のカルテの場合はMarkdown)。

認証
ユーザートークン
パラメーター
  • idinteger必須
  • prompt[json_notes]object任意
  • prompt[markdown_content]string任意

PATCH/api/v1/encounters/:id/update_markdown

Markdown形式のカルテのMarkdownを置き換えます。保存時にJSON形式のカルテも同期されます。

認証
ユーザートークン
パラメーター
  • idinteger必須
  • prompt[markdown_content]string必須
リクエスト
curl -X PATCH https://api.scribemd.ai/api/v1/encounters/12345/update_markdown \
  -H "Authorization: Bearer $SCRIBEMD_USER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "prompt": { "markdown_content": "#### Chief Complaint\nCough for 3 days." } }'
レスポンス
{
  "data": {
    "id": 12345,
    "uuid": "1bc91eb0-ca16-40a5-87c5-ccc7b6cb4f14",
    "note_format": "markdown",
    "markdown_content": "#### Chief Complaint\nCough for 3 days.",
    "json_notes": { "...": "..." }
  }
}

POST/mcp

AIアシスタント向けの読み取り専用Model Context Protocolサーバー。

認証
OAuth

SDKとMCP

RESTの先へ

  • モバイルSDK

    ScribeMDの録音とカルテ機能を、iOSまたはAndroidアプリに追加できます。

    SDKガイドを読む
  • MCPサーバー

    Model Context Protocolを通じて、OAuthでサインインしたAIアシスタントをScribeMDに接続できます。

制限とエラー

レート制限とエラー

MCPサーバーとOAuthエンドポイントには、IPアドレスごとのレート制限があります。上限を超えると429 Too Many Requestsを返します。

エラー

エラーは、エラーメッセージとHTTPステータスを含むJSONで返されます:

400
必須パラメーターがないか、無効です。
401
APIキーまたはトークンがないか、無効です。
403
組織がロックされています。
404
このキーまたはユーザーに該当する診察がありません。
422
リクエストを保存できませんでした(例:無効な言語またはタイムスタンプ)。

セキュリティ

臨床データのための設計

  • HIPAAに準拠し、業務提携契約(BAA)を締結しています。
  • HTTPS/TLSにより、クライアントとサーバー間、サービス間のすべての通信を暗号化します。
  • データベース、オブジェクトストレージ、バックアップは保存時に暗号化されます。
セキュリティについて詳しく見る

はじめる

Request API Access

貴社の製品とAPIの活用方法についてお聞かせください。メールでご連絡いたします。