Upcoming Changes

Overview

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.

Deprecation of Documents Classic

With Guided Documents (POST /documents) now in General Availability, Documents Classic (POST /interactions/{id}/documents) and its companion endpoints (GET /templates, GET /templates/{key}, GET /templateSections) are deprecated.

Property	Description
Change	`POST /interactions/{id}/documents` (Documents Classic) is deprecated in favor of `POST /documents` (Guided Documents). The companion template and section listing endpoints (`GET /templates`, `GET /templates/{key}`, `GET /templateSections`) are deprecated in favor of `LIST /documents/templates` and `LIST /documents/sections`.
Affected endpoints	POST /interactions//documents, GET /templates, GET /templates/, GET /templateSections
Impact	All affected endpoints continue to work until the shutdown date. No new features will be added to Classic. New integrations should build on Guided Documents immediately.
Shutdown date	January 18th, 2027: All Documents Classic endpoints will be removed. Migrate before this date.
Related Guide	Migrate from Classic — field-by-field mapping from `POST /interactions/{id}/documents` to `POST /documents`.

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.
Affected endpoints	POST/transcripts
Impact	`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).
Shutdown date	Undefined: No removal date is currently planned.

Change to diarization parameter for streams endpoint

Property	Description
Change	The `/streams` configuration parameter `isDiarization` is being renamed `diarize` to match the equivalent parameter on the `/transcripts` endpoint.
Affected endpoints	wss/streams
Impact	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.

Formatting Change for Medical Codes

Property	Description
Change	To align with standard formatting, Corti will update the API response of medical codes to include decimal points.
Affected endpoints	Predict Codes
Impact	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
Change date	May 22nd, 2026

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`
Affected endpoints	List templates, List template sections, Get template
Impact	Both snake_case and camelCase or slightly renamed properties are being returned until the shutdown date.
Shutdown date	January 6th, 2026: We will not return snake_case properties anymore, please ensure you have adopted any necessary changes before that date.
Related Guide	Retrieving available templates

Property name change for additionalInstructions

Property	Description
Change	As we evolve the documents endpoint, we are renaming the `additionalInstructions` property to `additionalInstructionsOverride` for clarity that this field overrides any existing default.
Affected endpoints	POST documents from dynamic template
Impact	Until shutdown, both the now deprecated `additionalInstructions` as well as the new `additionalInstructionsOverride` are accepted in the request.
Shutdown date	January 6th, 2026: We will not accept `additionalInstructions` anymore, please ensure you have adopted any necessary changes before.
Related Guide	Advanced Document Generation

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.
Affected endpoints	POST documents from dynamic template
Impact	Until shutdown, both the now deprecated `sectionKeys` string[] as well as the new `sections` object[] can be passed in the request.
Shutdown date	January 6th, 2026: We will not accept `sectionKeys` anymore, please ensure you have adopted any necessary changes before.
Related Guide	Advanced Document Generation

Get started

SDKs & tools

Implementation guides

Release notes

Resources

Overview

Deprecation of Documents Classic

Change to punctuation parameters for transcripts endpoint

Change to diarization parameter for streams endpoint

Formatting Change for Medical Codes

Property name changes for GET template(s), GET sections

Property name change for additionalInstructions

Request schema change for POST documents template object

​Overview

​Deprecation of Documents Classic

​Change to punctuation parameters for transcripts endpoint

​Change to diarization parameter for streams endpoint

​Formatting Change for Medical Codes

​Property name changes for GET template(s), GET sections

​Property name change for additionalInstructions

​Request schema change for POST documents template object

Overview

Deprecation of Documents Classic

Change to punctuation parameters for transcripts endpoint

Change to diarization parameter for streams endpoint

Formatting Change for Medical Codes

Property name changes for GET template(s), GET sections

Property name change for additionalInstructions

Request schema change for POST documents template object