Skip to main content

Listen — From audio file asynchronously



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.



    file_url stringrequired

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

    output_objects listen_output_object[]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_languagerequired

    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).

    split_by_sentence booleanrequired

    Default value: false

    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.

    note_generation_mode copilot_note_generation_mode

    Possible values: [highest_quality, fastest]

    Choose a generation mode:

    highest_quality: generates very high quality notes, might take up to one minute;

    fastest: quicker note generation (few seconds), but might not give the best possible output.

    Default is highest_quality.

    note_template copilot_note_template


    The desired template of the generated note. Default is GENERAL_MEDICINE. Check Note template for details.

    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

    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.


Request received and processing started.

    request_id uuidrequired

    The id of the request you just created.

    client_request_id string

    The provided client_request_id.