All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Note -- New read-only resource with two endpoints: retrieve a collection of notes (
GET /notes) and retrieve a single note (GET /notes/{uuid}). Filterable by uuid, type, patient, audio, createdAt, updatedAt. Sortable by uuid, type, createdAt, updatedAt. Scope:read:notes.
- Audio -- Removed filter parameters
summaryandsummary[]fromGET /audios.
- Published the OpenAPI 3.1.0 specification for the Askara public API with OAuth2 authorization code security scheme.
- Audio -- Endpoints to retrieve a collection of audios and retrieve a single audio by UUID (read-only). Supports pagination, ordering, text search, and patient expand filters.
- Contact -- Endpoints to list, create, retrieve, and update contacts. Supports pagination, ordering, text search, and archive filtering.
- Document -- Endpoints to list documents, retrieve a single document, and set a document synchronization status. Supports filtering by synchronization state for integration workflows.
- Organization -- Endpoints to list organizations and retrieve a single organization by UUID (read-only).
- Patient -- Endpoints to list, create or update (upsert), retrieve, and patch patients. Supports pagination, ordering, text search, external ID matching, and archive filtering.
- User -- Endpoints to retrieve the current authenticated user (
/me) and retrieve a user by UUID (read-only). - Webhook -- Endpoints to list, create, retrieve, update, and delete webhooks for event-driven integrations.
- Published the OpenAPI 3.1.0 specification for the Askara SpeechToText API, secured via API key (
X-API-KEYheader). - Transcription -- Asynchronous endpoint to submit an audio file URL for speech-to-text processing with a callback URL for result delivery.