Ambient note generation from audio recording and conversational transcript
Endpoint | Capability | Use |
---|---|---|
Interactions | The 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 |
Recordings | Upload audio files that can be used for transcript generation | Required |
Transcripts | Generate transcripts for audio files that are associated with the interaction | Required |
Documents | Ambient note generation based on template and language defined in the request | Required |
Templates | Get details for available templates that define the structure and language of generated documents | Optional |
POST
request to the /interactions
endpoint.id
for the interaction and a WebSocket URL (wssUrl
). The identifier will be used to manage the subsequent steps of the workflow.POST
request to /interactions/:id/recording
.200
status and returns a recordingId
, confirming that the audio file has been successfully uploaded and linked to the interaction.POST
request to /interactions/:id/transcripts
.200
status with the generated transcript. This transcript contains the text version of the recorded interaction, extracted and formatted for review.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.200
status along with the final document, which is ready for use or further editing.POST
requests to the /documents
endpoint with different templateKey
to generate multiple notes for a given interaction.