Skip to main content

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.

Unreleased​

  • Remove suggested_dot_phrases from response of /generate-note in Server API as it has always been null (Dot Phrases are only applicable for User API).
  • Add new CRUD endpoints to manage Dictation Text Replacements for a user.

2025-05-21​

  • Add new boolean fields is_hcc and is_mcc to the FHIR condition objects returned by the /generate-normalized-data endpoint.

2025-05-07​

  • Change the dictate WebSocket protocol. The WebSocket dictation protocol evolves to a faster and simpler model, where small units of text —such as individual words, short phrases, or punctuation marks— are sent once and don’t require any further updates. Clients are expected to append each received unit in order, without inserting spaces or applying any formatting. This change introduces the following breaking changes.
    • Evolution of configuration options in CONFIG frame.
      • The dictate_punctuation field has been renamed to punctuation_mode and is now an enum, with currently one possible value: EXPLICIT.
      • The speech_locale field has been renamed to dictate_locale and is reduced to the five following locales: ENGLISH_US, ENGLISH_UK, SPANISH_ES, SPANISH_MX and FRENCH_FR.
      • The enable_audio_chunk_ack option has been removed, since audio acknowledgement is now always activated.
    • Simplification and renaming of DICTATION_ITEM frame:
      • The DICTATION_ITEM frame type has been renamed to DICTATED_TEXT.
      • It has been simplified and now contains only a string text property.
      • Fields id, is_final, start_offset_ms and end_offset_ms properties have been removed since dictated texts are now necessarily final and are returned in chronological order.
  • Add new code, name and trace_id fields in WebSockets error frame JSON body. Also, the message field formatting changed (reminder: do not rely on this formatted string but only on the numeric code).

2025-05-05​

  • Add new corresponding_note_problem in the conditions returned by /generate-normalized-data endpoint. Use the include_corresponding_note_problems flag in the input body to enable this feature.

2025-04-03​

  • Enforce a limit of 700 on the length of the custom instructions per section for note generation endpoints
  • Add new User API endpoints to allow users to configure and persist their note generation preferences:
  • Change in User API /generate-note and /generate-note-async endpoints:
    • The following fields have been removed from the request body:
      • note_locale
      • note_template
      • note_sections_customization
    • These endpoints will now automatically apply the settings stored in the user’s note settings and per-section customization.

2025-02-25​

  • Bilingual support has been added to transcription endpoints and Websocket.
    • In request bodies and WS config frame, speech_locale property has been removed and replaced by new speech_locales property, an array that can contain one or two distinct speech locales.

2025-01-07​

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​

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.