Upgrades

Keeping track of breaking changes between versions

Your API version controls the API you see (for example, what properties you see in responses, what parameters you’re permitted to send in requests, and so on).

When a breaking change is introduced to the Copilot API, a new dated version is released and your calls to the API are not affected as long as you don't change the version you want to query (see Targeting a specific version).

Below is a list of all available versions of the Copilot API (each date corresponds to version), and their associated breaking changes. If you’re looking for all API additions and updates, check out our Changelog page.

2024-04-22

• 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

• Remove note.section.content: string[] field, usage to be replaced by text: string which is equivalent but formatted.

2023-06-26

First version of the API.