HEheidihealth
Heidi API

Generate Consult Note

Changed on

Generate a session consult note by either template, ai command or ai command text or generate a session dictation. dictation - AI cleaned up transcript

post/api/v2/ml-scribe/open-api/sessions/{session_id}/consult-note

Request

  • Base URL
    https://au.api.heidihealth.com
  • Auth
    HTTP bearer

Path parameters

session_idstring required

Request body

generation_method'TEMPLATE' | 'THIRD_PARTY_TEMPLATE' | 'DICTATION' | 'AUTO_MODE' required
template_idstring nullable
third_party_templatestring nullable
additionstring
voice_style'BRIEF' | 'GOLDILOCKS' | 'DETAILED' | 'MY_VOICE' | 'SUPER_DETAILED' required

was called writing style

brain'LEFT' | 'RIGHT'

Brain enum for different AI model configurations.

Each brain represents a different AI model configuration with specific characteristics:

  • LEFT: Fast and simple model
  • RIGHT: Creative and artistic model
content_type'MARKDOWN'
dictation_cleanup_mode'SMART' | 'WORD_FOR_WORD'
ignore_backupboolean

Example request

{
  "template_id": "5eb7cf5a86d9755df3a6c593"
}

Response

Successful Response

unknown required

Changes

  • 353da1bac96fRevision changes
    • info

      added the new AUTO_MODE enum value to the request property

    • info

      added the new DICTATION enum value to the request property