Download OpenAPI specification:
Voice recordings, transcription processing and document management
Stream and download a document that was previously uploaded to Kana. Returns the file content directly for display or download in your application. Supports all document types stored via the document upload endpoint.
Use this when:
Input:
file_name (required): Name of the file to retrievefile_url (required): Storage path returned by the upload endpointReturns: Streamed file content with appropriate Content-Type header
Upload clinical documents (PDFs, Word files, images) to Kana's secure storage and immediately extract their text content using Azure Document Intelligence. Extracted content is returned and can be used as context for AI note generation, clinical documentation, or chat queries.
Use this when:
Supported file types: PDF, DOCX, images (JPEG, PNG, TIFF)
Input (multipart/form-data):
files (required): One or more documents to upload and processuserid (required): Client's Kana user IDrole (required): "User" or "Therapist"feature (required): Feature context identifier (e.g. "TherapistNotes")Returns: Array of objects with content (extracted text), file_name, and file_url for each uploaded document (HTTP 201)
Upload an audio recording of a therapy session to Kana's secure cloud storage. Kana stores the recording and queues it for AI transcription and session summary generation. Recordings are organized by therapist, client, and date. Multiple audio chunks (e.g. from a segmented recording) can be uploaded; set is_last_blob=true on the final chunk to trigger downstream processing.
Use this when:
Input (multipart/form-data):
file (required): Audio file to uploadtherapist_userid (required): Therapist's Kana user IDtherapist_clientid (required): Therapist-client relationship IDsession_id (required): Active session IDis_last_blob (required): true if this is the final audio chunkclient_userid (optional): Client's Kana user IDtherapist_session_id (optional): Associated session IDReturns: Record ID and upload status
| filename | string or null <= 512 characters |
| userid | integer or null |
| is_processed | boolean or null |
| therapist_client_id | integer or null |
| create_timestamp | string or null <date-time> |
| update_timestamp | string or null <date-time> |
| session_id | string or null <= 255 characters |
| is_last_blob | boolean or null |
| therapist_session_id | integer or null |
{- "filename": "string",
- "userid": 0,
- "is_processed": true,
- "therapist_client_id": 0,
- "create_timestamp": "2019-08-24T14:15:22Z",
- "update_timestamp": "2019-08-24T14:15:22Z",
- "session_id": "string",
- "is_last_blob": true,
- "therapist_session_id": 0
}{- "id": 0,
- "filename": "string",
- "userid": 0,
- "is_processed": true,
- "therapist_client_id": 0,
- "create_timestamp": "2019-08-24T14:15:22Z",
- "update_timestamp": "2019-08-24T14:15:22Z",
- "session_id": "string",
- "is_last_blob": true,
- "therapist_session_id": 0
}Retrieve the full history of session transcripts for a client, ordered by most recent first. Returns all transcript versions including revisions, giving a complete audit trail of what was transcribed across all sessions.
Use this when:
Input:
userid (required): The client's Kana user IDtherapist_clientid (required): The therapist-client relationship IDReturns: Array of transcript history records ordered by most recent (HTTP 200). HTTP 204 if no history found.
| transcript_summary required | string |
| client_user_id | integer or null |
| therapist_user_id | integer or null |
| therapist_client_id | integer or null |
| date required | string <date-time> |
| therapist_session_id | integer or null |
{- "transcript_summary": "string",
- "client_user_id": 0,
- "therapist_user_id": 0,
- "therapist_client_id": 0,
- "date": "2019-08-24T14:15:22Z",
- "therapist_session_id": 0
}{- "id": 0,
- "transcript_summary": "string",
- "client_user_id": 0,
- "therapist_user_id": 0,
- "therapist_client_id": 0,
- "date": "2019-08-24T14:15:22Z",
- "therapist_session_id": 0
}Trigger AI transcription of session audio recordings that were previously uploaded to Kana. Kana retrieves all audio files for the specified therapist-client-date combination, runs Azure Speech-to-Text transcription, and returns the transcribed text. Transcripts feed into Kana's AI pipeline for session summary and SOAP note generation.
Use this when:
Input:
userid (required): Therapist's Kana user IDtherapist_clientid (required): Therapist-client relationship IDdate (required): Session date in YYYY-MM-DD formatReturns: Array of transcript text objects for all recordings on that date