Heidi API

Create Session

create a new session

post/api/v2/ml-scribe/open-api/sessions

Request

timezonestring nullable

IANA timezone (for example Australia/Sydney). Required when created_time_local includes a UTC offset.

language_codestring nullable

language_code_liststring[] nullable

output_language_codestring nullable

template_idstring nullable

Consult-note template for this session, or AUTO_MODE.

patient_profile_idstring nullable

ehr_patient_idstring nullable

ehr_appt_idstring nullable

created_time_localstring date-time nullable

Successful Response

session_idstring required

is_consentboolean nullable