Home
Providers
Heidi Health
Heidi Health
Heidi Health is a Melbourne, Australia-founded AI care partner for clinicians, founded in 2019 by Dr. Tom Kelly (CEO), Waleed Mussa (CFO), and Yu Liu (CTO). The product began as an ambient AI medical scribe and now spans four capability surfaces: Scribe (real-time clinical documentation from audio), Evidence (clinical decision support and literature lookup with citations), Remote (a 21-gram wearable microphone with on-device encryption for offline ambient capture), and Comms (clinical communications). The platform is used by more than one million clinicians across 50+ countries spanning family medicine, specialists, nursing, mental health, allied health, dentistry, veterinary medicine, and trainees, and claims to have returned over 18 million hours of clinician time to date. Heidi exposes a public Heidi API and embeddable Heidi Widget that EHR vendors, telehealth platforms, and partners use to embed ambient documentation into their own workflows; documented integrations include Epic (Hyperspace/Hyperdrive/Haiku), Oracle Cerner (PowerChart/FirstNet), Athenahealth, eClinicalWorks (via Vim), Best Practice, Medical Director, Gentu, Cliniko, Halaxy, MediRecords, and many others. Heidi holds SOC 2, ISO 27001, ISO 42001, HIPAA, GDPR, APP, PIPEDA, NHS, Cyber Essentials+, UKCA, and Swiss FDPA attestations, has raised approximately $80M across Seed, Series A (Blackbird), and a $65M Series B led by Point72 Private Investments with Blackbird, Headline, and Latitude, and recently announced a strategic partnership with R1 RCM to embed Heidi into US revenue cycle management workflows.
Heidi Health publishes 10 APIs on the APIs.io network, including Ask Heidi API, Authentication API, Clinical Coding API, and 7 more. Tagged areas include Healthcare, Health Tech, AI Medical Scribe, Ambient AI, and Clinical Documentation.
The Heidi Health catalog on APIs.io includes 1 JSON-LD context and 2 Spectral governance rulesets.
Heidi Health’s developer surface includes authentication, developer portal, documentation, signup flow, pricing, engineering blog, changelog, and 37 more developer resources.
1 APIs
20 Features
On this page
Kin Score
APIs 11
Postman 10
Open Collections 12
Pricing Plans 1
Rate Limits 1
FinOps 1
Features 20
Vocabularies 1
Spectral Rules 2
JSON Schema 6
JSON Structure 1
Examples 4
Security Posture 3
Agentic Access 1
Resources 44
apis.yml
16 Operational Transparency
0 Create-or-Update Ergonomics
Composite quality — 48.2/100 · developing
Agent readiness — 21/100 · agent aware
Individual APIs this provider publishes, each with its own machine-readable definition.
Scroll for all 11
Ready-to-run Postman collections for exercising this provider's APIs.
Scroll for all 10
Open, tool-agnostic API collections (OpenAPI-derived and Bruno).
Scroll for all 12
Published pricing tiers and plan structures.
Documented rate limits and quota policies.
Cost, billing, and metering signals for API financial operations.
Notable capabilities this provider offers.
Heidi Scribe — ambient AI medical scribe generating real-time consult notes from clinical audio
Heidi Evidence — clinical decision-support and literature lookup with transparent citations and CPD/CME tracking
Heidi Remote — 21-gram wearable microphone with offline capture and on-device encryption
Heidi Comms — clinical communications module
Heidi API — public REST API at registrar.api.heidihealth.com for sessions, transcription, consult notes, documents, coding, Ask Heidi
Heidi Widget — embeddable JavaScript widget for any web-based EHR
Custom JSON templates for organisation-specific consult-note structures
Multilingual transcription and output across 50+ countries
Voice-style controls (Goldilocks, Detailed, Brief, Super-Detailed, My Voice)
Clinical coding generation in ICD-10, ICD-10-CM, ICD-9, ICD-9-CM, SNOMED, SNOMED-CT, OPCS-410, ACHI-13, CPT-2025
Streamed generation responses for incremental UI rendering
Patient profiles linking many sessions to a single patient for longitudinal context
Context attachments (PDF, JPG, PNG, DOCX, DOC) per session
EHR integrations spanning Epic, Cerner, Athenahealth, eClinicalWorks (via Vim), Best Practice, Medical Director, Gentu, Cliniko, Halaxy, MediRecords, and 15+ others
Free plan with unlimited transcription and standard templates
Evidence Plus, Clinician, and Enterprise paid tiers with 14-day trials
Enterprise features including SSO, centralised billing, custom hosting, dedicated CSM
SOC 2, ISO 27001, ISO 42001, HIPAA, GDPR, APP, PIPEDA, NHS, Cyber Essentials+, UKCA, Swiss FDPA compliance
No clinician data used for AI model training
R1 RCM strategic partnership for US revenue cycle management
Scroll for all 20
JSON-LD contexts and semantic vocabularies used across these APIs.
Spectral governance rulesets for linting and validating these APIs.
Standalone JSON Schema definitions for this provider's data models.
JSON Structure definitions describing this provider's data shapes.
Example request and response payloads for these APIs.
Authentication, domain security, vulnerability disclosure, and trust-center signals.
Recommended x-agentic-access execution contracts for AI agents.
Get Started 3
Portal, sign-up, and the first successful call
Documentation 2
Reference material describing how the API behaves
Agent Surfaces 1
MCP servers, agent skills, and machine-readable catalogs
Design & Contract 3
Pagination, idempotency, versioning, errors, and events
Build 1
SDKs, sample code, and the tooling you integrate with
Access & Security 9
Authentication, authorization, and security posture
Scroll for all 9
Operate 6
Status, limits, changes, and where to get help
Commercial 5
Pricing, plans, and the legal terms of use
Company 5
The organization behind the API
Other 9
Properties that don't map to a standard resource type
Scroll for all 9
Source (apis.yml)
aid: heidi-health
name: Heidi Health
description: 'Heidi Health is a Melbourne, Australia-founded AI care partner for clinicians, founded in 2019 by Dr. Tom Kelly
(CEO), Waleed Mussa (CFO), and Yu Liu (CTO). The product began as an ambient AI medical scribe and now spans four capability
surfaces: Scribe (real-time clinical documentation from audio), Evidence (clinical decision support and literature lookup
with citations), Remote (a 21-gram wearable microphone with on-device encryption for offline ambient capture), and Comms
(clinical communications). The platform is used by more than one million clinicians across 50+ countries spanning family
medicine, specialists, nursing, mental health, allied health, dentistry, veterinary medicine, and trainees, and claims to
have returned over 18 million hours of clinician time to date. Heidi exposes a public Heidi API and embeddable Heidi Widget
that EHR vendors, telehealth platforms, and partners use to embed ambient documentation into their own workflows; documented
integrations include Epic (Hyperspace/Hyperdrive/Haiku), Oracle Cerner (PowerChart/FirstNet), Athenahealth, eClinicalWorks
(via Vim), Best Practice, Medical Director, Gentu, Cliniko, Halaxy, MediRecords, and many others. Heidi holds SOC 2, ISO
27001, ISO 42001, HIPAA, GDPR, APP, PIPEDA, NHS, Cyber Essentials+, UKCA, and Swiss FDPA attestations, has raised approximately
$80M across Seed, Series A (Blackbird), and a $65M Series B led by Point72 Private Investments with Blackbird, Headline,
and Latitude, and recently announced a strategic partnership with R1 RCM to embed Heidi into US revenue cycle management
workflows.'
tags:
- Healthcare
- Health Tech
- AI Medical Scribe
- Ambient AI
- Clinical Documentation
- Clinical Decision Support
- Artificial Intelligence
- Speech-to-Text
- Transcription
- EHR Integration
- Electronic Health Records
- Telehealth
- Clinical Coding
- ICD-10
- SNOMED
- HIPAA
- GDPR
- SOC 2
- ISO 27001
- ISO 42001
- Wearables
- Voice
- Audio
- Australia
- Melbourne
tags_raw:
- Healthcare
- Health Tech
- AI Medical Scribe
- Ambient AI
- Clinical Documentation
- Clinical Decision Support
- Artificial Intelligence
- Speech To Text
- Transcription
- EHR Integration
- Electronic Health Records
- Telehealth
- Clinical Coding
- ICD-10
- SNOMED
- HIPAA
- GDPR
- SOC 2
- ISO 27001
- ISO 42001
- Wearables
- Voice
- Audio
- Australia
- Melbourne
url: https://raw.githubusercontent.com/api-evangelist/heidi-health/refs/heads/main/apis.yml
deliveryModel:
model: saas
open_source: false
commercial: true
callable_host: true
label: Hosted service · you call their endpoint
confidence: high
source:
- openapi
- pricing
generated: '2026-08-28'
method: derived
accessModel:
pricing: freemium
onboarding: self-serve
trial: true
try_now: true
public: false
label: Freemium (free trial) · Self-serve signup
confidence: high
source:
- plans
- authentication
generated: '2026-07-22'
method: derived
created: '2026-05-24'
modified: '2026-05-24'
specificationVersion: '0.23'
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/heidi-health.png
kind: contract
position: Producing
access: 3rd-Party
apis:
- aid: heidi-health:heidi-widget-sdk
name: Heidi Widget SDK
description: Embeddable JavaScript widget for dropping Heidi's ambient documentation experience directly into a web-based
EHR or clinical workflow with minimal engineering, with documented initialisation options, methods/callbacks, patient-information
parameters, and TypeScript types.
humanURL: https://www.heidihealth.com/developers/widget/overview
tags:
- Widget
- SDK
- Embed
- JavaScript
- EHR Integration
properties:
- type: Documentation
url: https://www.heidihealth.com/developers/widget/overview
- type: Documentation
url: https://www.heidihealth.com/developers/widget/install-the-widget
- type: Documentation
url: https://www.heidihealth.com/developers/widget/sdk-specification/initialisation-options
- type: Documentation
url: https://www.heidihealth.com/developers/widget/sdk-specification/methods-and-callbacks
- type: Documentation
url: https://www.heidihealth.com/developers/widget/sdk-specification/patient-information
- type: Documentation
url: https://www.heidihealth.com/developers/widget/sdk-specification/types
- aid: heidi-health:heidi-health-ask-heidi-api
name: Heidi Health Ask Heidi API
description: Streamed AI-assistant responses scoped to a session.
humanURL: https://www.heidihealth.com/developers/heidi-api/authentication
tags:
- Ask Heidi
properties:
- type: OpenAPI
url: openapi/heidi-health-ask-heidi-api-openapi.yml
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/authentication
- type: Examples
url: examples/heidi-health-get-jwt-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/templates
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/patient-profiles
- type: JSONSchema
url: json-schema/heidi-health-patient-profile-schema.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/sessions/overview
- type: JSONSchema
url: json-schema/heidi-health-session-schema.json
- type: JSONStructure
url: json-structure/heidi-health-session-structure.json
- type: Examples
url: examples/heidi-health-create-session-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/sessions/context
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/sessions/coding
- type: JSONSchema
url: json-schema/heidi-health-clinical-code-schema.json
- type: Examples
url: examples/heidi-health-get-clinical-codes-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/transcription
- type: JSONSchema
url: json-schema/heidi-health-transcript-schema.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/consult-notes
- type: JSONSchema
url: json-schema/heidi-health-consult-note-schema.json
- type: Examples
url: examples/heidi-health-generate-consult-note-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/documents
- type: JSONSchema
url: json-schema/heidi-health-document-schema.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/ask-heidi
- aid: heidi-health:heidi-health-authentication-api
name: Heidi Health Authentication API
description: Token exchange.
humanURL: https://www.heidihealth.com/developers/heidi-api/authentication
tags:
- Authentication
properties:
- type: OpenAPI
url: openapi/heidi-health-authentication-api-openapi.yml
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/authentication
- type: Examples
url: examples/heidi-health-get-jwt-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/templates
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/patient-profiles
- type: JSONSchema
url: json-schema/heidi-health-patient-profile-schema.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/sessions/overview
- type: JSONSchema
url: json-schema/heidi-health-session-schema.json
- type: JSONStructure
url: json-structure/heidi-health-session-structure.json
- type: Examples
url: examples/heidi-health-create-session-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/sessions/context
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/sessions/coding
- type: JSONSchema
url: json-schema/heidi-health-clinical-code-schema.json
- type: Examples
url: examples/heidi-health-get-clinical-codes-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/transcription
- type: JSONSchema
url: json-schema/heidi-health-transcript-schema.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/consult-notes
- type: JSONSchema
url: json-schema/heidi-health-consult-note-schema.json
- type: Examples
url: examples/heidi-health-generate-consult-note-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/documents
- type: JSONSchema
url: json-schema/heidi-health-document-schema.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/ask-heidi
- aid: heidi-health:heidi-health-clinical-coding-api
name: Heidi Health Clinical Coding API
description: ICD/SNOMED/CPT and related code generation.
humanURL: https://www.heidihealth.com/developers/heidi-api/authentication
tags:
- Clinical Coding
properties:
- type: OpenAPI
url: openapi/heidi-health-clinical-coding-api-openapi.yml
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/authentication
- type: Examples
url: examples/heidi-health-get-jwt-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/templates
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/patient-profiles
- type: JSONSchema
url: json-schema/heidi-health-patient-profile-schema.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/sessions/overview
- type: JSONSchema
url: json-schema/heidi-health-session-schema.json
- type: JSONStructure
url: json-structure/heidi-health-session-structure.json
- type: Examples
url: examples/heidi-health-create-session-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/sessions/context
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/sessions/coding
- type: JSONSchema
url: json-schema/heidi-health-clinical-code-schema.json
- type: Examples
url: examples/heidi-health-get-clinical-codes-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/transcription
- type: JSONSchema
url: json-schema/heidi-health-transcript-schema.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/consult-notes
- type: JSONSchema
url: json-schema/heidi-health-consult-note-schema.json
- type: Examples
url: examples/heidi-health-generate-consult-note-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/documents
- type: JSONSchema
url: json-schema/heidi-health-document-schema.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/ask-heidi
- aid: heidi-health:heidi-health-consult-notes-api
name: Heidi Health Consult Notes API
description: Streamed consult-note generation.
humanURL: https://www.heidihealth.com/developers/heidi-api/authentication
tags:
- Consult Notes
properties:
- type: OpenAPI
url: openapi/heidi-health-consult-notes-api-openapi.yml
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/authentication
- type: Examples
url: examples/heidi-health-get-jwt-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/templates
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/patient-profiles
- type: JSONSchema
url: json-schema/heidi-health-patient-profile-schema.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/sessions/overview
- type: JSONSchema
url: json-schema/heidi-health-session-schema.json
- type: JSONStructure
url: json-structure/heidi-health-session-structure.json
- type: Examples
url: examples/heidi-health-create-session-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/sessions/context
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/sessions/coding
- type: JSONSchema
url: json-schema/heidi-health-clinical-code-schema.json
- type: Examples
url: examples/heidi-health-get-clinical-codes-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/transcription
- type: JSONSchema
url: json-schema/heidi-health-transcript-schema.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/consult-notes
- type: JSONSchema
url: json-schema/heidi-health-consult-note-schema.json
- type: Examples
url: examples/heidi-health-generate-consult-note-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/documents
- type: JSONSchema
url: json-schema/heidi-health-document-schema.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/ask-heidi
- aid: heidi-health:heidi-health-documents-api
name: Heidi Health Documents API
description: Auxiliary template-driven documents.
humanURL: https://www.heidihealth.com/developers/heidi-api/authentication
tags:
- Documents
properties:
- type: OpenAPI
url: openapi/heidi-health-documents-api-openapi.yml
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/authentication
- type: Examples
url: examples/heidi-health-get-jwt-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/templates
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/patient-profiles
- type: JSONSchema
url: json-schema/heidi-health-patient-profile-schema.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/sessions/overview
- type: JSONSchema
url: json-schema/heidi-health-session-schema.json
- type: JSONStructure
url: json-structure/heidi-health-session-structure.json
- type: Examples
url: examples/heidi-health-create-session-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/sessions/context
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/sessions/coding
- type: JSONSchema
url: json-schema/heidi-health-clinical-code-schema.json
- type: Examples
url: examples/heidi-health-get-clinical-codes-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/transcription
- type: JSONSchema
url: json-schema/heidi-health-transcript-schema.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/consult-notes
- type: JSONSchema
url: json-schema/heidi-health-consult-note-schema.json
- type: Examples
url: examples/heidi-health-generate-consult-note-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/documents
- type: JSONSchema
url: json-schema/heidi-health-document-schema.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/ask-heidi
- aid: heidi-health:heidi-health-patient-profiles-api
name: Heidi Health Patient Profiles API
description: Longitudinal patient records.
humanURL: https://www.heidihealth.com/developers/heidi-api/authentication
tags:
- Patient Profiles
properties:
- type: OpenAPI
url: openapi/heidi-health-patient-profiles-api-openapi.yml
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/authentication
- type: Examples
url: examples/heidi-health-get-jwt-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/templates
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/patient-profiles
- type: JSONSchema
url: json-schema/heidi-health-patient-profile-schema.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/sessions/overview
- type: JSONSchema
url: json-schema/heidi-health-session-schema.json
- type: JSONStructure
url: json-structure/heidi-health-session-structure.json
- type: Examples
url: examples/heidi-health-create-session-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/sessions/context
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/sessions/coding
- type: JSONSchema
url: json-schema/heidi-health-clinical-code-schema.json
- type: Examples
url: examples/heidi-health-get-clinical-codes-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/transcription
- type: JSONSchema
url: json-schema/heidi-health-transcript-schema.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/consult-notes
- type: JSONSchema
url: json-schema/heidi-health-consult-note-schema.json
- type: Examples
url: examples/heidi-health-generate-consult-note-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/documents
- type: JSONSchema
url: json-schema/heidi-health-document-schema.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/ask-heidi
- aid: heidi-health:heidi-health-session-context-api
name: Heidi Health Session Context API
description: Notes, linked sessions, and context document attachments.
humanURL: https://www.heidihealth.com/developers/heidi-api/authentication
tags:
- Session Context
properties:
- type: OpenAPI
url: openapi/heidi-health-session-context-api-openapi.yml
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/authentication
- type: Examples
url: examples/heidi-health-get-jwt-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/templates
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/patient-profiles
- type: JSONSchema
url: json-schema/heidi-health-patient-profile-schema.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/sessions/overview
- type: JSONSchema
url: json-schema/heidi-health-session-schema.json
- type: JSONStructure
url: json-structure/heidi-health-session-structure.json
- type: Examples
url: examples/heidi-health-create-session-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/sessions/context
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/sessions/coding
- type: JSONSchema
url: json-schema/heidi-health-clinical-code-schema.json
- type: Examples
url: examples/heidi-health-get-clinical-codes-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/transcription
- type: JSONSchema
url: json-schema/heidi-health-transcript-schema.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/consult-notes
- type: JSONSchema
url: json-schema/heidi-health-consult-note-schema.json
- type: Examples
url: examples/heidi-health-generate-consult-note-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/documents
- type: JSONSchema
url: json-schema/heidi-health-document-schema.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/ask-heidi
- aid: heidi-health:heidi-health-sessions-api
name: Heidi Health Sessions API
description: Clinical session lifecycle.
humanURL: https://www.heidihealth.com/developers/heidi-api/authentication
tags:
- Sessions
properties:
- type: OpenAPI
url: openapi/heidi-health-sessions-api-openapi.yml
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/authentication
- type: Examples
url: examples/heidi-health-get-jwt-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/templates
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/patient-profiles
- type: JSONSchema
url: json-schema/heidi-health-patient-profile-schema.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/sessions/overview
- type: JSONSchema
url: json-schema/heidi-health-session-schema.json
- type: JSONStructure
url: json-structure/heidi-health-session-structure.json
- type: Examples
url: examples/heidi-health-create-session-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/sessions/context
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/sessions/coding
- type: JSONSchema
url: json-schema/heidi-health-clinical-code-schema.json
- type: Examples
url: examples/heidi-health-get-clinical-codes-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/transcription
- type: JSONSchema
url: json-schema/heidi-health-transcript-schema.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/consult-notes
- type: JSONSchema
url: json-schema/heidi-health-consult-note-schema.json
- type: Examples
url: examples/heidi-health-generate-consult-note-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/documents
- type: JSONSchema
url: json-schema/heidi-health-document-schema.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/ask-heidi
- aid: heidi-health:heidi-health-templates-api
name: Heidi Health Templates API
description: Consult-note templates.
humanURL: https://www.heidihealth.com/developers/heidi-api/authentication
tags:
- Templates
properties:
- type: OpenAPI
url: openapi/heidi-health-templates-api-openapi.yml
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/authentication
- type: Examples
url: examples/heidi-health-get-jwt-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/templates
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/patient-profiles
- type: JSONSchema
url: json-schema/heidi-health-patient-profile-schema.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/sessions/overview
- type: JSONSchema
url: json-schema/heidi-health-session-schema.json
- type: JSONStructure
url: json-structure/heidi-health-session-structure.json
- type: Examples
url: examples/heidi-health-create-session-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/sessions/context
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/sessions/coding
- type: JSONSchema
url: json-schema/heidi-health-clinical-code-schema.json
- type: Examples
url: examples/heidi-health-get-clinical-codes-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/transcription
- type: JSONSchema
url: json-schema/heidi-health-transcript-schema.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/consult-notes
- type: JSONSchema
url: json-schema/heidi-health-consult-note-schema.json
- type: Examples
url: examples/heidi-health-generate-consult-note-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/documents
- type: JSONSchema
url: json-schema/heidi-health-document-schema.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/ask-heidi
- aid: heidi-health:heidi-health-transcription-api
name: Heidi Health Transcription API
description: Audio upload and transcript retrieval.
humanURL: https://www.heidihealth.com/developers/heidi-api/authentication
tags:
- Transcription
properties:
- type: OpenAPI
url: openapi/heidi-health-transcription-api-openapi.yml
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/authentication
- type: Examples
url: examples/heidi-health-get-jwt-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/templates
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/patient-profiles
- type: JSONSchema
url: json-schema/heidi-health-patient-profile-schema.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/sessions/overview
- type: JSONSchema
url: json-schema/heidi-health-session-schema.json
- type: JSONStructure
url: json-structure/heidi-health-session-structure.json
- type: Examples
url: examples/heidi-health-create-session-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/sessions/context
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/sessions/coding
- type: JSONSchema
url: json-schema/heidi-health-clinical-code-schema.json
- type: Examples
url: examples/heidi-health-get-clinical-codes-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/transcription
- type: JSONSchema
url: json-schema/heidi-health-transcript-schema.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/consult-notes
- type: JSONSchema
url: json-schema/heidi-health-consult-note-schema.json
- type: Examples
url: examples/heidi-health-generate-consult-note-example.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/documents
- type: JSONSchema
url: json-schema/heidi-health-document-schema.json
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/ask-heidi
common:
- type: CapabilityMap
url: capabilities/heidi-health-capability-edges.yml
name: Heidi Health Business Capability Map
- type: PostmanWorkspace
url: https://www.postman.com/kinlaneapi/heidi-health/overview
- type: AgenticAccess
url: agentic-access/heidi-health-agentic-access.yml
- type: VulnerabilityDisclosure
url: security/heidi-health-vulnerability-disclosure.yml
- type: DomainSecurity
url: security/heidi-health-domain-security.yml
- type: Authentication
url: authentication/heidi-health-authentication.yml
- type: Website
url: https://www.heidihealth.com
- type: Portal
url: https://www.heidihealth.com/developers
- type: Documentation
url: https://www.heidihealth.com/developers/heidi-api/overview
- type: Documentation
url: https://www.heidihealth.com/developers/faq
- type: Signup
url: https://scribe.heidihealth.com/register
- type: Login
url: https://scribe.heidihealth.com/login
- type: Pricing
url: https://www.heidihealth.com/pricing
- type: Blog
url: https://www.heidihealth.com/blog
- type: ChangeLog
url: https://www.heidihealth.com/changelog
- type: StatusPage
url: https://status.heidihealth.com
- type: TrustCenter
url: https://trust.heidihealth.com
- type: Support
url: https://support.heidihealth.com
- type: PrivacyPolicy
url: https://www.heidihealth.com/legal/privacy-policy
- type: TermsOfService
url: https://www.heidihealth.com/legal/terms-of-service
- type: AcceptableUse
url: https://www.heidihealth.com/legal/usage-policy
- type: Compliance
url: https://www.heidihealth.com/compliance/hipaa
- type: Compliance
url: https://www.heidihealth.com/compliance/gdpr
- type: Compliance
url: https://www.heidihealth.com/compliance/uk
- type: Compliance
url: https://www.heidihealth.com/compliance/canada
- type: Compliance
url: https://www.heidihealth.com/compliance/au-nz
- type: Safety
url: https://www.heidihealth.com/safety
- type: Company
url: https://www.heidihealth.com/company
- type: Customers
url: https://www.heidihealth.com/customer-stories
- type: Press
url: https://www.heidihealth.com/media
- type: Careers
url: https://www.heidihealth.com/careers
- type: Contact
url: https://www.heidihealth.com/contact
- type: Contact
url: https://www.heidihealth.com/contact-sales
- type: Partners
url: https://www.heidihealth.com/partners
- type: Integrations
url: https://www.heidihealth.com/integrations
- type: Downloads
url: https://www.heidihealth.com/downloads
- type: SystemRequirements
url: https://www.heidihealth.com/system-requirements
- type: Templates
url: https://www.heidihealth.com/template-community
- type: ROICalculator
url: https://www.heidihealth.com/roi-calculator
- type: Plans
url: plans/heidi-health-plans-pricing.yml
- type: RateLimits
url: rate-limits/heidi-health-rate-limits.yml
- type: FinOps
url: finops/heidi-health-finops.yml
- type: JSONLD
url: json-ld/heidi-health-context.jsonld
- type: Vocabulary
url: vocabulary/heidi-health-vocabulary.yml
- type: SpectralRules
url: rules/heidi-health-rules.yml
- type: Features
data:
- Heidi Scribe — ambient AI medical scribe generating real-time consult notes from clinical audio
- Heidi Evidence — clinical decision-support and literature lookup with transparent citations and CPD/CME tracking
- Heidi Remote — 21-gram wearable microphone with offline capture and on-device encryption
- Heidi Comms — clinical communications module
- Heidi API — public REST API at registrar.api.heidihealth.com for sessions, transcription, consult notes, documents, coding,
Ask Heidi
- Heidi Widget — embeddable JavaScript widget for any web-based EHR
- Custom JSON templates for organisation-specific consult-note structures
- Multilingual transcription and output across 50+ countries
- Voice-style controls (Goldilocks, Detailed, Brief, Super-Detailed, My Voice)
- Clinical coding generation in ICD-10, ICD-10-CM, ICD-9, ICD-9-CM, SNOMED, SNOMED-CT, OPCS-410, ACHI-13, CPT-2025
- Streamed generation responses for incremental UI rendering
- Patient profiles linking many sessions to a single patient for longitudinal context
- Context attachments (PDF, JPG, PNG, DOCX, DOC) per session
- EHR integrations spanning Epic, Cerner, Athenahealth, eClinicalWorks (via Vim), Best Practice, Medical Director, Gentu,
Cliniko, Halaxy, MediRecords, and 15+ others
- Free plan with unlimited transcription and standard templates
- Evidence Plus, Clinician, and Enterprise paid tiers with 14-day trials
- Enterprise features including SSO, centralised billing, custom hosting, dedicated CSM
- SOC 2, ISO 27001, ISO 42001, HIPAA, GDPR, APP, PIPEDA, NHS, Cyber Essentials+, UKCA, Swiss FDPA compliance
- No clinician data used for AI model training
- R1 RCM strategic partnership for US revenue cycle management
maintainers:
- FN: Kin Lane
email: kin@apievangelist.com
Every provider here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for providers
9 MCP tools reach this
find_providersBrowse and filter every provider in the catalog.
get_provider_artifactsEvery artifact this provider publishes, grouped by type.
get_provider_operationsEvery operation across all of their OpenAPIs — one call instead of parsing every spec.
get_provider_toolsEvery MCP tool they ship, with the operation each wraps.
get_provider_evidenceHow each part of their score was established. Free — the basis for a claim should not sit behind it.
get_provider_ratingPRO — composite, band, trend and facet scores.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This provider
curl "https://apis.io/api/v1/providers/heidi-health"
All providers
curl "https://apis.io/api/v1/providers?limit=25"
Every operation they expose
curl "https://apis.io/api/v1/providers/heidi-health/operations?limit=25"
How their score was established
curl "https://apis.io/api/v1/providers/heidi-health/evidence"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms .
A second provider on the same verified email joins the account you already have.