Skip to main content

Listen Endpoint

This endpoint is used to transcribe an audio file and return the result as a JSON object. Input parameters: audio_file, output_objects, language, note_template, style Requires a valid access token in the Authorization header.

Request Body REQUIRED
request object REQUIRED
output_objects Output Objects REQUIRED
language Language REQUIRED

Possible values: [en-US, fr-CA]

note_template Note Template REQUIRED

Possible values: [soap, consult]

style Style REQUIRED

Possible values: [paragraph, bullet, auto]

note_gen_mode Note Gen Mode REQUIRED

Possible values: [fast, medium, best]

transcribe_gen_mode Transcribe Gen Mode REQUIRED

Possible values: [fast, medium, best]

audio_file binary REQUIRED
Responses
200

Successful Response

Schema OPTIONAL
transcript object[] OPTIONAL
text Text
speaker Speaker

Possible values: [provider, patient, unknown]

note object[] OPTIONAL
sec_title Sec Title

Possible values: [SOAP_SUBJECTIVE, SOAP_OBJECTIVE, SOAP_ASSESSMENT, SOAP_PLAN, REASON_FOR_REFERRAL, HISTORY_OF_PRESENT_ILLNESS, PAST_MEDICAL_HISTORY, MEDICATIONS, ALLERGIES, SOCIAL_HISTORY, FAMILY_HISTORY, ASSESSMENT, PLAN]

sec_heading Sec Heading
sec_text Sec Text
404

Not found

422

Validation Error

Schema OPTIONAL
detail object[] OPTIONAL
loc undefined[]
msg Message
type Error Type