As detailed in our Changes Policy, we from time to time are forced to introduce breaking changes as we evolve our API.
Similarly, we might once in a while deprecate existing functionalities when newer functionalities serve a similar purpose in a better way.This page lists all upcoming deprecations and their potential breaking change impact details.The update date on this page indicates the release date where we announce the deprecation. It is immediately in effect, while the shutdown (sunset) date is the date where only the new API behaviour or model is available anymore.
Change to punctuation parameters for transcripts endpoint
Property
Description
Change
The /transcripts configuration parameter isDictation is being deprecated in favor of spokenPunctuation and automaticPunctuation to match the equivalent parameter on the /transcribe endpoint.
isDictation is replaced by spokenPunctuation and automaticPunctuation. It is ignored when either of those fields are provided. When isDictation is defined as true and neither new field is provided, it is treated as spokenPunctuation: true (automatic punctuation off).
Both parameter names will be accepted: diarize (canonical) takes precedence over the deprecated isDiarization alias when both are supplied.
Shutdown date
Undefined: both parameters will be supported indefinitely.
Related Guide
A deprecation warning will be logged when a client supplies only the legacy isDiarization field. CONFIG_ACCEPTED echoes both diarize and isDiarization so existing clients reading the response keep working; isDiarization will be dropped from the echo once the parameter is fully deprecated.
Medical Codes generated by the API will include decimal points. Client side formatting to add decimal points will no longer be needed. Example: A code currently returned as M751 will be returned as M75.1
Property name changes for GET template(s), GET sections
Property
Description
Change
To align with our API conventions, we are changing from snake_case to camelCase property naming. Some properties are renamed: date_updated -> updatedAt, section_type -> type, sections_id -> section
As we evolve the documents endpoint, we are renaming the additionalInstructions property to additionalInstructionsOverride for clarity that this field overrides any existing default.
Request schema change for POST documents template object
Property
Description
Change
As we evolve the documents endpoint, we are changing the request schema when assembling sections into a template at the request. We are deprecating the sectionKeys property of type string[] in favour of the new sections property of type object[]. The new property requires at minimum a key with the sectionKey as value and can be optionally extended to customize several section fields with overrides. As previously and unchanged: the sorting of sections is implicit as set by the order of keys in the array.
Corti Assistant