---
title: "Edit Latest Consult Note"
method: PATCH
path: "/api/v2/ml-scribe/open-api/sessions/{session_id}/consult-note"
tags: ["Heidi API"]
---

# Edit Latest Consult Note

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

## Request

- Base URL: `https://au.api.heidihealth.com`
- URL: `https://au.api.heidihealth.com/api/v2/ml-scribe/open-api/sessions/{session_id}/consult-note`
- Auth: HTTP bearer

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

## Path parameters

- `session_id` string, required

## Request body

- UpdateLatestConsultNoteRequest: All fields are optional. Only include the fields you want to change.
  - `edited_note` string
  - `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_id` string, nullable
  - `content_type` 'MARKDOWN'

## Response `200`

Successful Response

- UpdateConsultNoteResponse
  - `consult_note` SimpleConsultNoteView, required
    - `status` 'CREATED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED'
    - `result` string, nullable
    - `heading` string
    - `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
    - `voice_style` 'BRIEF' | 'GOLDILOCKS' | 'DETAILED' | 'MY_VOICE' | 'SUPER_DETAILED': was called writing style
    - `generation_method` 'TEMPLATE' | 'THIRD_PARTY_TEMPLATE' | 'DICTATION' | 'AUTO_MODE', required
    - `template_id` string, nullable
    - `ai_command_id` string, nullable
    - `ai_command_text` string, nullable
    - `feedback` Feedback
      - `rating` 1 | 2 | 3 | 4 | 5, required
      - `feedback` FeedbackRatingReason[]
        - `reason` string, required
      - `detail` string
      - `updated` string, date-time
    - `dictation_cleanup_mode` 'SMART' | 'WORD_FOR_WORD'
    - `content_type` 'MARKDOWN'
    - `should_retry` boolean
    - `failure_reason` 'transcript_too_short' | 'transcript_available_but_note_generation_failed' | 'transcript_not_available' | 'llm_errored_during_streaming' | 'unexpected_error': UX/UI friendly reason why note generation failed
    - `generation_time` string, nullable
    - `custom_style` CustomStyle
      - `level_of_detail` 'LOW' | 'MEDIUM' | 'HIGH', required
      - `bullet_points_preference` boolean: Whether to use bullet points in the note
      - `patient_quotes_preference` boolean: Whether to include patient quotes in the note
      - `abbreviations_preference` boolean: Whether to use abbreviations in the note
    - `is_personalization_applied` boolean, nullable
    - `created_at` string, date-time, nullable
    - `updated_at` string, date-time, nullable
  - `total_replacement_count` integer

## Other responses

- `422`: Validation Error

## Changes

- **2026-09-22** `353da1bac96f`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/heidihealth/apis/heidi-api-documentation/changes/api/v2/ml-scribe/open-api/sessions/:session_id/consult-note/patch.md)

---

[API](https://skmtc.dev/heidihealth/apis/heidi-api-documentation.md) - [All operations](https://skmtc.dev/heidihealth/apis/heidi-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/heidihealth/apis/heidi-api-documentation/revisions/d764c8c0883f?raw)