Understanding Corti API endpoints
Interactions
Recordings
POST
request to /interactions/:interactionId/recording/
. The API responds with a 200 status code and returns a recordingId
, confirming that the audio file has been successfully uploaded and linked to the specific interaction. Use the ‘recordingId’ in your next step, such as generating transcripts or documents.Transcripts
/interactions/:interactionId/transcripts/
. The API then processes the audio and returns a 200 status code along with the generated transcript. This transcript contains the text version of the recorded interaction, extracted and formatted for review. The transcripts endpoint plays a crucial role in converting speech to text for clinical conversations and dictations, enabling further processing and documentation creation based on the interaction data.Transcribe
Streams
Facts
Documents
/interactions/:interactionId/documents/
. This request utilizes generated transcripts and a templateKey defined in the request to specify the desired format of the output document. Upon processing the request, the API returns a 200 status code along with the final document.This endpoint allows for the generation of documentation tailored to specific needs, such as clinical notes or referral letters, based on the interaction data and predefined templates. The endpoint can be called multiple times for a given interaction if multiple document outputs are desired. See more details in the Templates & Documents page.Templates
Codes
Codes
Alignment
Classification
Contextual Chat
Contextual Retrieval
Predictive Prompt
Explainability