HEheidihealth
Heidi API

Edit Latest Consult Note

Changed on

Update the latest consult note for the session. All body fields are optional.

patch/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

edited_notestring
voice_style'BRIEF' | 'GOLDILOCKS' | 'DETAILED' | 'MY_VOICE' | 'SUPER_DETAILED'

was called writing style

generation_method'TEMPLATE' | 'THIRD_PARTY_TEMPLATE' | 'DICTATION' | 'AUTO_MODE'
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
template_idstring nullable
content_type'MARKDOWN'

Example request

{
  "template_id": "5eb7cf5a86d9755df3a6c593"
}

Response

Successful Response

total_replacement_countinteger

Example response

{
  "consult_note": {
    "template_id": "5eb7cf5a86d9755df3a6c593",
    "ai_command_id": "5eb7cf5a86d9755df3a6c593"
  }
}

Changes