Skip to main content

Generate a note asynchronously

POST 
/digest_async

Digests a list of transcript items and produces a structured clinical note.

Request​

Body

required
    callback_url stringrequired

    Once we are done processing the input and generating the 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/digest).

    output_objects digest_output_object[]required

    Possible values: [note]

    Specifies which items you want us to send you back. In other words, which feature(s) you want to use, for now only note generation is available.

    language copilot_languagerequired

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

    Language of the given transcript and the desired note ('fr' and 'en' are deprecated, and correspond to 'fr-FR' and 'en-US' respectively).

    transcript_items object[]required

    The transcript from which to generate the note.

  • Array [
    • text stringrequired

    The transcribed text.

    speaker copilot_speakerrequired

    Possible values: [doctor, patient, unspecified]

    Who said the text in this transcript item.

  • ]
    • 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.

    section_style copilot_section_style

    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.

    note_template copilot_note_template

    Possible values: [GENERAL_MEDICINE, CARDIOLOGY, PSYCHIATRY, DIET, PSYCHOLOGY, SOAP]

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

    note object

    Optional initial Note to be enhanced using the new transcript_items. This is useful if you generate notes gradually to avoid accumulating a very long transcript items list. Typically, this will be the last note Nabla generated for you along with the new transcript_items that did not serve for its generation. Important: This is expected to be a recent (up to few-hours old) Nabla-generated note. If the note is too old or altered, you will get an error.

    sections object[]required

    Sections of the note.

  • Array [
    • key stringrequired

    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 string

    Content of the note section (required).

  • ]
    • 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.

Responses​

Request received and processing started.

Schema
    request_id uuidrequired

    The id of the request you just created.

    client_request_id string

    The provided client_request_id.

Loading...