API Reference

Corti API Documentation

Support

Legacy Documentation

List All Interactions

A unique identifier for the encounter, essential for tracking and referencing specific patient interactions.

The time period during which the encounter takes place.

Indicates the current state of the encounter, crucial for understanding the progression and current state of care.

The specific type of encounter, providing context about the nature and setting of the patient interaction.

The end date/time of the encounter. (UTC)

The start date/time of the encounter. (UTC)

FHIR reference to patient gender. Ensures the documentation is written with the correct pronouns.

FHIR reference to Text representation of the full name. Ensures the patient is referred by their name in the documentation.

FHIR reference to patient extension Individual Pronouns.

Introduction

AI Platform

Authentication

Discover the flexibility of Corti Copilot API

Example Workflows

Create Interaction

Get Existing Interaction

Delete Interaction

Update Interaction

 Establish WSS connection. See placeholder `TRACE` method for client/server messages in the socket.

Stream Interaction

Due to OpenAPI limitation this is a dummy placeholder for the client/server messages in WSS stream.

WSS client/server messages.

List Facts

 Generate facts from provided transcript, replacing existing ones.

Generate Facts

 When creating a Fact if the interaction status = “in progress” then the Client will receive the newly created fact over the WebSocket.

Create Facts

 When updating a `Fact` if the interaction `status = “in progress”` then the Client will receive the updated fact over the WebSocket. To discard a fact, simply set `discarded = true`

Update Fact

List Documents

Create Document

Get Document

Update Document

List Codes

Predict Codes

Select Codes

List Recordings

 Accept only audio of max 60 minutes in length and 150MB in size.

Upload Recording

Get Recording

Delete Recording

 Time-out for this endpoint is 10 minutes.

Transcribe Audio

Get Transcript

 Compares a 'source' document with a 'target' document and returns a percentage alignment, optionally including aligned segments.

Align Sections

 This endpoint is used for binary classification tasks where a boolean output is expected.

Create Classification

 Allows users to ask questions or make queries, which are processed in the context of a specific interaction. Multiple tools provide responses via SSE. A thread ID is returned with the initial query, which can be used to continue posting to the same thread in subsequent queries.

Contextual Query Assistant

 Processes a query and returns a summary along with relevant sources.

Guidelines Tool API

 Finds mentions of a query within a set of reference texts.

Mentions Tool API

 Provides a list of suggested questions based on a query and/or context.

interactions

stream

facts

documents

codes

recordings

transcripts

experimental

List All Interactions

Query Parameters

Response