Skip to main content

​
Introduction

The Asynchronous Ambient Documentation Workflow is the most common “AI scribe” workflow in use today. While the real-time ambient documentation workflow is designed for scenarios where immediate processing and feedback are essential during the patient visit, this workflow processes a complete audio file and within seconds returns a document generated based on the conversational transcript. In scenarios where real-time processing isn’t required or feasible, the asynchronous workflow provides flexibility and predictability.

​
Endpoints and Capabilities

EndpointCapabilityUse
InteractionsThe foundational unit that ties together all related data and operations, enabling a cohesive workflow from the start of the interaction to the generation of final documentation.Required
RecordingsUpload audio files that can be used for transcript generationRequired
TranscriptsGenerate transcripts for audio files that are associated with the interactionRequired
DocumentsAmbient note generation based on template and language defined in the requestRequired
TemplatesGet details for available templates that define the structure and language of generated documentsOptional

​
Workflow

1

Create interaction

  1. The workflow begins with the client initiating an interaction by sending a POST request to the /interactions endpoint.
  2. The API responds with a unique id for the interaction and a WebSocket URL (wssUrl). The identifier will be used to manage the subsequent steps of the workflow.
2

Upload audio recording

  1. Once the interaction is initialized, the client uploads an audio file associated with that interaction by sending a POST request to /interactions/:id/recording.
  2. The API responds with a 200 status and returns a recordingId, confirming that the audio file has been successfully uploaded and linked to the interaction.
3

Create conversational transcript

  1. After the recording is uploaded, the client initiates the transcription process by sending a POST request to /interactions/:id/transcripts.
  2. The API processes the audio and returns a 200 status with the generated transcript. This transcript contains the text version of the recorded interaction, extracted and formatted for review.
4

Generate document(s)

  1. Finally, the client creates the necessary documentation by sending a POST request to /interactions/:id/documents. This request includes the transcript generated in the previous step and a templateKey to specify the format of the output document.
  2. The API processes the request and returns a 200 status along with the final document, which is ready for use or further editing.
  3. Submit multiple POST requests to the /documents endpoint with different templateKey to generate multiple notes for a given interaction.
See details on Templates and how to use them here