Listen — From audio file asynchronously

POST 
/listen_async

Generate a transcript and a structured clinical note from an audio file. Only audio/* mime types are supported. The maximum duration is 60 minutes. The result of the request is posted to the callback URL once available.

Request

application/json

Body

required

output_objects listen_output_object (string)[]required

Possible values: [transcript_item, note]

Specifies which items you want us to send you back. In other words, which feature(s) you want to use, transcription and/or note generation.

language copilot_language (string)required

Possible values: [fr, en, en-US, en-GB, fr-FR, es-ES, es-MX]

Language spoken in the audio ('fr' and 'en' are deprecated, and correspond to 'fr-FR' and 'en-US' respectively. Generating a note in 'es-ES' and 'es-MX' is not supported and will be soon removed).

split_by_sentence boolean

Indicates whether to segment transcription results at sentence boundaries. Default is false, meaning that a single transcript item may encompass multiple sentences, provided they are not delineated by pauses (silence) in the audio.

section_style copilot_section_style (string)

Possible values: [auto, paragraphs, bullet_points]

Choose a desired style for note sections:

• paragraphs: Prioritizes generating paragraphs;

• bullet_points: Prioritizes structuring content using bullet points.

• auto: Automatically picks the most natural formatting option.

Default is auto.

split_by_problem copilot_split_by_problem (boolean)

Flag to structure the content of the note sections according to distinct clinical problems or topics addressed during the consultation.

When this flag is enabled, the text within some sections of the clinical note is organized into subsections, each corresponding to a specific problem or topic. This format aims to enhance the clarity and organization of the clinical note, making it easier to read and understand the different issues discussed during the consultation.

Important: Currently, the application of this flag is limited to the HISTORY_OF_PRESENT_ILLNESS and SOAP_SUBJECTIVE sections and is only effective when the language is set to English (US or GB).

note_template copilot_note_template (string)

Possible values: [GENERAL_MEDICINE, GENERAL_MEDICINE_AP_MERGED, CARDIOLOGY, PSYCHIATRY, DIET, PSYCHOLOGY, SOAP, GENERAL_MEDICINE_WCC, SOAP_WCC, GENERAL_MEDICINE_EMERGENCY, SOAP_EMERGENCY]

The desired template of the generated note.

Some templates are only available in specific languages. Check Note template for details.

file_url stringrequired

The URL of the audio file to download & listen to.

callback_url stringrequired

Once we are done processing the input and generating the transcript & note, we will call you back with a 'POST' on this URL and a Json body respecting exactly the same schema as the response of the synchronous equivalent endpoint (i.e. /copilot/listen).

client_request_id copilot_client_request_id (string)

Possible values: <= 128 characters

An optional unique client-made id for this request. When specified, this id is included in the Json payload that will be sent asynchronously. This can help clients both guarantee idempotency and correlate asynchronous responses with their requests.

Note: this id must be different for every request. It is recommended to use a randomly generated UUID.

Responses

200

Request received and processing started.

application/json

Schema

Schema

request_id uuidrequired

The id of the request you just created.

client_request_id string

The provided client_request_id.

Example (from schema)

{
  "request_id": "98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6",
  "client_request_id": "string"
}

299

Here's the schema of the Json payload that will be sent asynchronously to the URL you provided. (299 is not a possible response code — only a way here to document the asynchronous payload schema).

application/json

Schema

Schema

oneOf
success
request_id uuidrequired
The id of the async request.
client_request_id string
The client_request_id provided in the request.
transcript object[]
Transcript items from the audio file.
Array [
text stringrequired
The transcribed text.
speaker copilot_speaker (string)required
Possible values: [doctor, patient, unspecified]
Who said the text in this transcript item.
start_offset_ms integerrequired
Start time of this transcription item as the offset, in milliseconds, from the start of the audio file.
end_offset_ms integerrequired
End time of this transcription item as the offset, in milliseconds, from the start of the audio file. Equals the start_time_ms plus the duration of the related transcribed audio portion.
]
note object
The generated note.
title string
Title of the note.
sections object[]required
Content of the note structured in multiple sections.
Array [
key copilot_note_section_key (string)required
Possible values: [ALLERGIES, APPOINTMENTS, ASSESSMENT, ASSESSMENT_AND_PLAN, CARDIOVASCULAR_RISKS, CHIEF_COMPLAINT, CURRENT_MEDICATIONS, DIET_APPOINTMENTS, DIET_CHIEF_COMPLAINT, DIET_HABITS, DIET_LIFESTYLE, DIET_MEDICAL_HISTORY, DIET_OBJECTIVES, DIET_VITALS, FAMILY_HISTORY, HISTORY_OF_PRESENT_ILLNESS, IMAGING_RESULTS, IMMUNIZATIONS, LAB_RESULTS, MENTAL_HEALTH_EXAM, MENTAL_HEALTH_HISTORY, PAST_MEDICAL_HISTORY, PAST_OBSTETRIC_HISTORY, PAST_SURGICAL_HISTORY, PHYSICAL_EXAM, PLAN, PRESCRIPTION, PSYCHOLOGY_HISTORY_OF_COMPLAINT, SOAP_ASSESSMENT, SOAP_OBJECTIVE, SOAP_PLAN, SOAP_SUBJECTIVE, SOCIAL_HISTORY, VITALS, WELL_CHILD_CARE]
A key identifying a section of a note. The set of possible keys depend on the template that is used. Check Note template for possible values.
title stringrequired
The section title.
text stringrequired
Content of the note section.
]
error
request_id uuidrequired
The id of the async request.
client_request_id string
The client_request_id provided in the request.
error_code integerrequired
error_message string

Loading...