2024-11-01

API Reference

Corti API Documentation

Updates

Support

Legacy Documentation

Updates and improvements to Corti's API and models

API Updates

Introduction

AI Platform

Authentication

Example Workflows

Find the latest updates across Corti's products

Overview

List All Interactions

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

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

Add Facts

 When updating a Facts if the interaction `status = "in progress"` then the Client will receive the updated fact over the WebSocket.

Update 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

Generate Document

Get Document

Delete Document

Update Document

 Get all codes associated with an interaction.

List codes

Select codes

Generate Codes

List Recordings

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

Upload Recording

Get Recording

Delete Recording

List Transcripts

Create Transcript

Get Transcript

Delete 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.