---
title: "Update Session"
method: PATCH
path: "/api/v2/ml-scribe/open-api/sessions/{session_id}"
tags: ["Heidi API"]
---

# Update Session

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

update session details by id

## Path parameters

- `session_id` string, required

## Request body

- OpenAPIUpdateSessionRequest
  - `language_code` 'ar-AE' | 'auto' | 'bg' | 'ca' | 'zh' | 'zh-Hant' | 'zh-HK' | 'cs' | 'da' | 'da-DK' | 'nl' | 'en' | 'en-US' | 'en-AU' | 'en-GB' | 'en-NZ' | 'en-IN' | 'et' | 'fi' | 'nl-BE' | 'fr' | 'fr-CA' | 'de' | 'de-CH' | 'el' | 'hi' | 'hi-Latn' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'ko-KR' | 'lv' | 'lt' | 'ms' | 'no' | 'pl' | 'pt' | 'pt-BR' | 'ro' | 'ru' | 'sk' | 'es' | 'es-419' | 'sv' | 'sv-SE' | 'th' | 'th-TH' | 'tr' | 'uk' | 'vi' | 'multi' | 'ar' | 'bn' | 'hr' | 'iw' | 'sr' | 'sl' | 'sw' | 'af' | 'am' | 'as' | 'az' | 'be' | 'bs' | 'ceb' | 'co' | 'cy' | 'dv' | 'eo' | 'eu' | 'fa' | 'fil' | 'fy' | 'ga' | 'gd' | 'gl' | 'gu' | 'ha' | 'haw' | 'hmn' | 'ht' | 'hy' | 'ig' | 'is' | 'jv' | 'ka' | 'kk' | 'km' | 'kn' | 'kri' | 'ku' | 'ky' | 'la' | 'lb' | 'lo' | 'mg' | 'mi' | 'mk' | 'ml' | 'mn' | 'mni-Mtei' | 'mr' | 'mt' | 'my' | 'ne' | 'ny' | 'or' | 'pa' | 'ps' | 'sd' | 'si' | 'sm' | 'sn' | 'so' | 'sq' | 'st' | 'su' | 'ta' | 'te' | 'to' | 'tg' | 'ug' | 'ur' | 'uz' | 'xh' | 'yi' | 'yo' | 'zu'
  - `output_language_code` 'ar-AE' | 'auto' | 'bg' | 'ca' | 'zh' | 'zh-Hant' | 'zh-HK' | 'cs' | 'da' | 'da-DK' | 'nl' | 'en' | 'en-US' | 'en-AU' | 'en-GB' | 'en-NZ' | 'en-IN' | 'et' | 'fi' | 'nl-BE' | 'fr' | 'fr-CA' | 'de' | 'de-CH' | 'el' | 'hi' | 'hi-Latn' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'ko-KR' | 'lv' | 'lt' | 'ms' | 'no' | 'pl' | 'pt' | 'pt-BR' | 'ro' | 'ru' | 'sk' | 'es' | 'es-419' | 'sv' | 'sv-SE' | 'th' | 'th-TH' | 'tr' | 'uk' | 'vi' | 'multi' | 'ar' | 'bn' | 'hr' | 'iw' | 'sr' | 'sl' | 'sw' | 'af' | 'am' | 'as' | 'az' | 'be' | 'bs' | 'ceb' | 'co' | 'cy' | 'dv' | 'eo' | 'eu' | 'fa' | 'fil' | 'fy' | 'ga' | 'gd' | 'gl' | 'gu' | 'ha' | 'haw' | 'hmn' | 'ht' | 'hy' | 'ig' | 'is' | 'jv' | 'ka' | 'kk' | 'km' | 'kn' | 'kri' | 'ku' | 'ky' | 'la' | 'lb' | 'lo' | 'mg' | 'mi' | 'mk' | 'ml' | 'mn' | 'mni-Mtei' | 'mr' | 'mt' | 'my' | 'ne' | 'ny' | 'or' | 'pa' | 'ps' | 'sd' | 'si' | 'sm' | 'sn' | 'so' | 'sq' | 'st' | 'su' | 'ta' | 'te' | 'to' | 'tg' | 'ug' | 'ur' | 'uz' | 'xh' | 'yi' | 'yo' | 'zu'
  - `duration` integer, nullable
  - `transcribe_mode` 'TRANSCRIBE' | 'DICTATE'
  - `patient` OpenAPIPatientUpdate
    - `name` string, nullable
    - `gender` string, nullable
    - `dob` string, nullable
    - `demographic_details` string, nullable
  - `clinician_notes` string[], nullable
  - `consult_note` OpenAPIUpdateConsultNoteRequest
    - `result` string, required
  - `latest_consult_note_id` string, nullable
  - `ehr_patient_id` string, nullable
  - `generate_output_without_recording` boolean, nullable
  - `recording_status` 'IDLE' | 'PAUSED' | 'RECORDING' — Represents the current status of the recording session.
  - `session_status` 'EMPTY' | 'DRAFT' | 'REVIEWED' | 'APPROVED' | 'SENT' — Represents the review workflow status of a session's letter/document.
  - `is_consent` boolean, nullable
  - `created_time_local` string, date-time, nullable
  - `linked_sessions_for_context` string[], nullable

## Response `200`

Successful Response

- SessionDetailsResponse
  - `session` DetailedSessionView, required
    - `session_id` string, required
    - `kinde_gp_id` string, required
    - `session_name` string, nullable
    - `session_gist` string, nullable
    - `patient` PatientModel — a model runs in parallel with PatientProfileModel when user choose to not create a patient profile.
      - `name` string, nullable
      - `gender` string, nullable
      - `dob` string, nullable
      - `demographic_details` string, nullable
      - `additional_context` string, nullable
    - `audio` AudioResponse[], nullable
      - `url` string, nullable
      - `transcript` string, nullable
      - `created_at` string, date-time, required
    - `clinician_notes` string[], required
    - `duration` integer
    - `created_at` string, date-time, nullable
    - `updated_at` string, date-time, nullable
    - `is_consent` boolean, nullable
    - `language_code` 'ar-AE' | 'auto' | 'bg' | 'ca' | 'zh' | 'zh-Hant' | 'zh-HK' | 'cs' | 'da' | 'da-DK' | 'nl' | 'en' | 'en-US' | 'en-AU' | 'en-GB' | 'en-NZ' | 'en-IN' | 'et' | 'fi' | 'nl-BE' | 'fr' | 'fr-CA' | 'de' | 'de-CH' | 'el' | 'hi' | 'hi-Latn' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'ko-KR' | 'lv' | 'lt' | 'ms' | 'no' | 'pl' | 'pt' | 'pt-BR' | 'ro' | 'ru' | 'sk' | 'es' | 'es-419' | 'sv' | 'sv-SE' | 'th' | 'th-TH' | 'tr' | 'uk' | 'vi' | 'multi' | 'ar' | 'bn' | 'hr' | 'iw' | 'sr' | 'sl' | 'sw' | 'af' | 'am' | 'as' | 'az' | 'be' | 'bs' | 'ceb' | 'co' | 'cy' | 'dv' | 'eo' | 'eu' | 'fa' | 'fil' | 'fy' | 'ga' | 'gd' | 'gl' | 'gu' | 'ha' | 'haw' | 'hmn' | 'ht' | 'hy' | 'ig' | 'is' | 'jv' | 'ka' | 'kk' | 'km' | 'kn' | 'kri' | 'ku' | 'ky' | 'la' | 'lb' | 'lo' | 'mg' | 'mi' | 'mk' | 'ml' | 'mn' | 'mni-Mtei' | 'mr' | 'mt' | 'my' | 'ne' | 'ny' | 'or' | 'pa' | 'ps' | 'sd' | 'si' | 'sm' | 'sn' | 'so' | 'sq' | 'st' | 'su' | 'ta' | 'te' | 'to' | 'tg' | 'ug' | 'ur' | 'uz' | 'xh' | 'yi' | 'yo' | 'zu'
    - `language_code_list` LanguageCode[], nullable
    - `output_language_code` 'ar-AE' | 'auto' | 'bg' | 'ca' | 'zh' | 'zh-Hant' | 'zh-HK' | 'cs' | 'da' | 'da-DK' | 'nl' | 'en' | 'en-US' | 'en-AU' | 'en-GB' | 'en-NZ' | 'en-IN' | 'et' | 'fi' | 'nl-BE' | 'fr' | 'fr-CA' | 'de' | 'de-CH' | 'el' | 'hi' | 'hi-Latn' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'ko-KR' | 'lv' | 'lt' | 'ms' | 'no' | 'pl' | 'pt' | 'pt-BR' | 'ro' | 'ru' | 'sk' | 'es' | 'es-419' | 'sv' | 'sv-SE' | 'th' | 'th-TH' | 'tr' | 'uk' | 'vi' | 'multi' | 'ar' | 'bn' | 'hr' | 'iw' | 'sr' | 'sl' | 'sw' | 'af' | 'am' | 'as' | 'az' | 'be' | 'bs' | 'ceb' | 'co' | 'cy' | 'dv' | 'eo' | 'eu' | 'fa' | 'fil' | 'fy' | 'ga' | 'gd' | 'gl' | 'gu' | 'ha' | 'haw' | 'hmn' | 'ht' | 'hy' | 'ig' | 'is' | 'jv' | 'ka' | 'kk' | 'km' | 'kn' | 'kri' | 'ku' | 'ky' | 'la' | 'lb' | 'lo' | 'mg' | 'mi' | 'mk' | 'ml' | 'mn' | 'mni-Mtei' | 'mr' | 'mt' | 'my' | 'ne' | 'ny' | 'or' | 'pa' | 'ps' | 'sd' | 'si' | 'sm' | 'sn' | 'so' | 'sq' | 'st' | 'su' | 'ta' | 'te' | 'to' | 'tg' | 'ug' | 'ur' | 'uz' | 'xh' | 'yi' | 'yo' | 'zu'
    - `documents` DocumentView[], nullable
      - `id` string, required
      - `session_id` string, required
      - `creator_kinde_id` string, nullable
      - `index` integer, nullable
      - `document_tab_type` 'DOCUMENT' | 'DICTATION' | 'PDF'
      - `name` string, nullable
      - `template_id` string, nullable
      - `ai_command_id` string, nullable
      - `question` string, nullable
      - `content` string, nullable
      - `updated_dictation` string, nullable
      - `created_at` string, date-time, nullable
      - `updated_at` string, date-time, nullable
      - `deleted_at` string, date-time, nullable
      - `generation_type` 'TEMPLATE'
      - `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
      - `content_type` 'MARKDOWN'
      - `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
    - `transcribe_mode` 'TRANSCRIBE' | 'DICTATE'
    - `transcript` string, nullable
    - `updated_dictation` string, nullable
    - `is_reviewed` boolean, nullable
    - `ehr_appt_id` string, nullable
    - `ehr_appt_contact_id` string, nullable
    - `ehr_provider` string, nullable
    - `ehr_encounter_id` string, nullable
    - `ehr_patient_id` string, nullable
    - `is_demo` boolean, required
    - `is_consumed_quota` boolean, required
    - `had_ws_recording_failure` boolean, required
    - `latest_consult_note_id` string, nullable
    - `client_customized_qa_template_answer` string, nullable
    - `do_recording_playback` boolean
    - `created_time_local` string, date-time, nullable
    - `session_status` 'EMPTY' | 'DRAFT' | 'REVIEWED' | 'APPROVED' | 'SENT' — Represents the review workflow status of a session's letter/document.
    - `patient_profile` PatientProfileModel
      - `id` string, nullable
      - `source` 'EHR' | 'HEIDI', required
      - `ehr` union
        - 'Epic Systems' | 'Other' | 'Heidi'
        - string
      - `ehr_patient_id` string, nullable
      - `managed_by` string, required
      - `birth_date` string, date, nullable
      - `gender` 'male' | 'female' | 'other' | 'unknown' — gender that matches FHIR API
      - `first_name` string, nullable
      - `last_name` string, nullable
      - `phone` string, phone, nullable
      - `email` string, email, nullable
      - `demographic_string` string, required
      - `remember_consent` boolean, nullable
      - `additional_context` string, nullable
      - `current_medications` string, nullable
      - `allergies` string, nullable
      - `past_medical_history` string, nullable
    - `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', 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
    - `language` LanguageView, required
      - `name` string, required
      - `code` 'ar-AE' | 'auto' | 'bg' | 'ca' | 'zh' | 'zh-Hant' | 'zh-HK' | 'cs' | 'da' | 'da-DK' | 'nl' | 'en' | 'en-US' | 'en-AU' | 'en-GB' | 'en-NZ' | 'en-IN' | 'et' | 'fi' | 'nl-BE' | 'fr' | 'fr-CA' | 'de' | 'de-CH' | 'el' | 'hi' | 'hi-Latn' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'ko-KR' | 'lv' | 'lt' | 'ms' | 'no' | 'pl' | 'pt' | 'pt-BR' | 'ro' | 'ru' | 'sk' | 'es' | 'es-419' | 'sv' | 'sv-SE' | 'th' | 'th-TH' | 'tr' | 'uk' | 'vi' | 'multi' | 'ar' | 'bn' | 'hr' | 'iw' | 'sr' | 'sl' | 'sw' | 'af' | 'am' | 'as' | 'az' | 'be' | 'bs' | 'ceb' | 'co' | 'cy' | 'dv' | 'eo' | 'eu' | 'fa' | 'fil' | 'fy' | 'ga' | 'gd' | 'gl' | 'gu' | 'ha' | 'haw' | 'hmn' | 'ht' | 'hy' | 'ig' | 'is' | 'jv' | 'ka' | 'kk' | 'km' | 'kn' | 'kri' | 'ku' | 'ky' | 'la' | 'lb' | 'lo' | 'mg' | 'mi' | 'mk' | 'ml' | 'mn' | 'mni-Mtei' | 'mr' | 'mt' | 'my' | 'ne' | 'ny' | 'or' | 'pa' | 'ps' | 'sd' | 'si' | 'sm' | 'sn' | 'so' | 'sq' | 'st' | 'su' | 'ta' | 'te' | 'to' | 'tg' | 'ug' | 'ur' | 'uz' | 'xh' | 'yi' | 'yo' | 'zu', required
      - `generate_consult_note_language_prompt_id` string, nullable
      - `ask_ai_language_prompt_id` string, nullable
      - `disclaimer` string, nullable
      - `is_scribe_default_language` boolean, required
      - `is_live` boolean, required
      - `is_beta` boolean, nullable
      - `is_available_for_dictation` boolean
    - `languages` LanguageView[], required
      - `name` string, required
      - `code` 'ar-AE' | 'auto' | 'bg' | 'ca' | 'zh' | 'zh-Hant' | 'zh-HK' | 'cs' | 'da' | 'da-DK' | 'nl' | 'en' | 'en-US' | 'en-AU' | 'en-GB' | 'en-NZ' | 'en-IN' | 'et' | 'fi' | 'nl-BE' | 'fr' | 'fr-CA' | 'de' | 'de-CH' | 'el' | 'hi' | 'hi-Latn' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'ko-KR' | 'lv' | 'lt' | 'ms' | 'no' | 'pl' | 'pt' | 'pt-BR' | 'ro' | 'ru' | 'sk' | 'es' | 'es-419' | 'sv' | 'sv-SE' | 'th' | 'th-TH' | 'tr' | 'uk' | 'vi' | 'multi' | 'ar' | 'bn' | 'hr' | 'iw' | 'sr' | 'sl' | 'sw' | 'af' | 'am' | 'as' | 'az' | 'be' | 'bs' | 'ceb' | 'co' | 'cy' | 'dv' | 'eo' | 'eu' | 'fa' | 'fil' | 'fy' | 'ga' | 'gd' | 'gl' | 'gu' | 'ha' | 'haw' | 'hmn' | 'ht' | 'hy' | 'ig' | 'is' | 'jv' | 'ka' | 'kk' | 'km' | 'kn' | 'kri' | 'ku' | 'ky' | 'la' | 'lb' | 'lo' | 'mg' | 'mi' | 'mk' | 'ml' | 'mn' | 'mni-Mtei' | 'mr' | 'mt' | 'my' | 'ne' | 'ny' | 'or' | 'pa' | 'ps' | 'sd' | 'si' | 'sm' | 'sn' | 'so' | 'sq' | 'st' | 'su' | 'ta' | 'te' | 'to' | 'tg' | 'ug' | 'ur' | 'uz' | 'xh' | 'yi' | 'yo' | 'zu', required
      - `generate_consult_note_language_prompt_id` string, nullable
      - `ask_ai_language_prompt_id` string, nullable
      - `disclaimer` string, nullable
      - `is_scribe_default_language` boolean, required
      - `is_live` boolean, required
      - `is_beta` boolean, nullable
      - `is_available_for_dictation` boolean
    - `generate_output_without_recording` boolean, nullable
    - `recording_status` 'IDLE' | 'PAUSED' | 'RECORDING' — Represents the current status of the recording session.
    - `linked_sessions_for_context` string[]
    - `past_ehr_notes` EHRNote[]
      - `binary_id` string, required
      - `note_content` string, required
    - `extracted_patient_context` PatientContextResponse — Simplified response model for api response
      - `first_name` string, nullable
      - `last_name` string, nullable
      - `birth_date` string, date, nullable
      - `gender` 'male' | 'female' | 'other' | 'unknown' — gender that matches FHIR API
      - `phone` string, phone, nullable
      - `email` string, email, nullable
      - `current_medications` string, nullable
      - `allergies` string, nullable
      - `past_medical_history` string, nullable

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/heidihealth/apis/heidi-api-documentation.md) · [All operations](https://skmtc.net/heidihealth/apis/heidi-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/heidihealth/heidi-api-documentation/versions/39b46a9d8637/schema)