Unfortunately, the Heidi API and Widget are no longer available for future integrations in Australia and New Zealand. If you are a current Heidi customer looking to integrate, reach out to your Customer Success representative. Otherwise, contact our team to find out what this means for you.
Heidi API
Overview

Heidi Open API

Overview

The Heidi Open API allows you to transcribe encounters and generate clinical notes and documents. This guide details the API endpoints, parameters, response formats, and examples for using the API effectively.

Base URL

The base URL for the API is https://<region>.api.heidihealth.com/api/v2/ml-scribe/open-api/, where <region> corresponds to your deployment region (e.g. au, us, uk, eu, ca).

RegionBase URL
Australia (au)https://au.api.heidihealth.com/api/v2/ml-scribe/open-api/
United States (us)https://us.api.heidihealth.com/api/v2/ml-scribe/open-api/
United Kingdom (uk)https://uk.api.heidihealth.com/api/v2/ml-scribe/open-api/
European Union (eu)https://eu.api.heidihealth.com/api/v2/ml-scribe/open-api/
Canada (ca)https://ca.api.heidihealth.com/api/v2/ml-scribe/open-api/

If you're not sure which region to use, see the region mapping.

Clinical data

Sessions, notes, documents, Ask Heidi, and transcription accept clinical content. Send only data the clinician has consent to process with Heidi. Do not log request bodies, transcripts, audio, or full URLs that include patient identifiers.

Specification

You can download a Postman collection containing all API endpoints and examples here and find a Swagger definition for the API here.

API flow

The following diagram shows the recommended flow for using the Heidi API.

WelcomeAuthentication