Changelog & Upgrades

Updates to the Nabla Core API — including new features, fields, or endpoints — are released under a new dated version to ensure stability and predictability. This means your integration won’t be affected by these changes unless you explicitly opt into the newer version (see Targeting a specific version).

That said, some updates — like internal AI models improvements, bug fixes, or strictly non-breaking changes that don’t affect the schema or observable behavior — may be rolled out across all versions.

Below is a list of all available Core API versions, along with their associated changes.

2024-12-23

• Add new audio chunk acknowledgement protocol, this change applies to all prior versions too.
• Require endpoints paths to start with either "/v1/core/server" or "/v1/core/user", paths like "copilot-api/server", "copilot/server", "copilot-api/user" or "copilot/user" are not supported anymore.

2024-11-08

• Fixed case for server-to-client frames in Transcribe Websocket. It is now SCREAMING_SNAKE_CASE for all the frames, e.g. transcript_item becomes TRANSCRIPT_ITEM.

2024-10-01

• New 2024-10-01 major API version. Check the Migration guide for an exhaustive list of the changes.
• Add support for OAuth Client authentication flow for server-to-server integrations.
• Add support for Webhooks with events sent upon completion of asynchronous tasks like asynchronous note generation.
• Add a new transcription websocket with a simpler frames schema, and support for 35 languages.
• Add a new note generation endpoint with per-section customization capabilities.
• Add a new asynchronous note generation endpoint with the ability to poll the result through a polling endpoint.
• Add a new transcription from file upload endpoint with a simpler body schema.
• Add a new transcription from file upload endpoint with the ability to poll the result through a polling endpoint.
• Change endpoints paths to start with either /v1/core/server or /v1/core/user.
• Change endpoints host to support for direct URL to a specific geographical region, e.g. us.api.nabla.com/* instead of just api.nabla.com/*.
• Remove or renamed endpoints (still supported on older versions for backward compatibility): /digest, /digest_async, /listen, /listen-ws, /listen_async, /generate_normalized_data, /generate_patient_instructions, /dot_phrases & /dot_phrases/{id}.

2024-04-22

• Add a new endpoint /generate_patient_instructions to generate a patient-friendly summary from an encounter.
• Add a new endpoint /generate_normalized_data to generate normalized data from a note, available on both the Server API and the User API.
• Add a new WebSocket endpoint /dictate for transcribing medical dictation.
• Add a new endpoint /users/find_by_external_id/:external_id to fetch a user with a unique external ID from another system.
• Add new endpoints to manage Dot Phrases for a user.
• When set on a user, suggest matching Dot Phrases alongside the generated note in the 'digest' endpoint.
• Add four new templates: GENERAL_MEDICINE_WCC, SOAP_WCC, GENERAL_MEDICINE_EMERGENCY, SOAP_EMERGENCY.
• Add a title property in the note generated by server digest, server digest async, user digest and user digest async endpoints. The title is a short description of the note content.
• Add a patient_context property in digest and digest_async requests body.
• Add a PATCH /users/:id endpoint.
• Add external_id, metadata and created_at on the User object, the external ID and metadata are editable through the patch endpoint.
• Remove upcoming_appointments_details from the output of the /generate_patient_instructions endpoint. Upcoming appointments details are now included inside instructions starting for this version.
• Remove note_generation_mode request property from digest and digest async endpoints.
• Remove upcoming_appointments_details from the output of the /generate_patient_instructions endpoint. Upcoming appointments details are now included inside instructions starting for this version.

2024-02-27

• Add new endpoints: activate-user & deactivate user.
• Add new endpoints to fetch a single user or all users using filters and pagination.
• Add split_by_problem to digest & listen-from-file endpoints.
• Add optional client_request_id parameter to /digest and /digest_async endpoints.
• Deprecate [es-ES, es-MX] as note generation languages in Core API for digest and listen endpoints.
• Remove note.section.content: string[] field, usage to be replaced by text: string which is equivalent but formatted.
• Remove note generation feature from Listen Websocket API (recommend using the dedicated endpoint).

2023-06-26

First version of the API.