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 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://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api/.

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.

Welcome Authentication