Heidi API Documentation

Name: Heidi API Documentation API
Brand: Heidi API Documentation
Availability: InStock

✓ Official Vendor SpecHealthcareEhr EmrapiKey, bearer29 EndpointsREST

For Agents

Create clinical scribe sessions, transcribe consultations, generate consult notes and clinical codes, and run ask-AI queries across 29 endpoints.

Quickstart

Get started with Heidi API Documentation in minutes using your preferred integration method.

# Add to your MCP client config (Claude Desktop, Cursor, Windsurf)
{
  "jentic": {
    "url": "https://api.jentic.com/mcp",
    "auth": "oauth"
  }
}

# Then ask your agent:
"generate a consult note from a clinician session"

# → Jentic returns the GET /events tool with parameter schema, agent executes.

Capabilities

What an agent can do with Heidi API Documentation API.

Mint a session JWT from your Heidi API key via GET /api/v2/ml-scribe/open-api/jwt

Create a new clinician scribe session via POST /api/v2/ml-scribe/open-api/sessions

Submit audio segments and trigger transcription via the restful-segment-transcription endpoints

Generate a structured consult note from a recorded session via POST /sessions/{session_id}/consult-note

GET STARTED

Start building with Heidi API Documentation API

Explore with Jentic

View OpenAPI Document

Use for: Create a new Heidi scribe session for a patient consultation, Get a JWT to authorise per-session Heidi API calls, Generate a consult note for a recorded session, Retrieve the transcript of a finished consultation

Not supported: Does not handle billing, prescription writing, lab orders, or patient demographics management — use for AI scribe sessions, transcripts, consult notes, and clinical codes only.

Heidi Health provides an AI medical scribe that listens to clinician-patient consultations and produces structured notes. The Heidi API exposes the underlying ml-scribe pipeline so applications can create sessions, stream audio segments for transcription, generate consult notes and clinical codes, retrieve transcripts, and run agentic ask-AI queries against the captured session. Authentication uses an API key to mint a JWT, then bearer tokens on per-session calls.

Use Cases

Patterns agents use Heidi API Documentation API for, with concrete tasks.

★ AI Medical Scribe for Telehealth

A telehealth platform uses Heidi to auto-generate consult notes from each video visit. The platform creates a Heidi session per visit, streams the audio segments, then calls /sessions/{session_id}/consult-note once the visit ends. Clinicians review the generated note inside the platform rather than typing it from scratch.

Create a session via POST /api/v2/ml-scribe/open-api/sessions, submit audio segments, then call POST /sessions/{session_id}/consult-note to receive the structured note

Clinical Coding Assistance

An EHR add-on extracts ICD/SNOMED-style codes from each consultation to assist billing. After a session is finished, the EHR calls GET /sessions/{session_id}/clinical-codes to retrieve the codes Heidi inferred and presents them to the coder for review and submission.

After finishing a session, call GET /api/v2/ml-scribe/open-api/sessions/{session_id}/clinical-codes and surface the suggested codes to the clinician

Customised Note Templates by Specialty

A multi-speciality clinic uses different templates for cardiology, paediatrics, and mental-health visits. The clinic lists available templates via /templates/document-templates and chooses the right one when calling the consult-note generator, so each note matches the specialty's preferred structure.

Call GET /api/v2/ml-scribe/open-api/templates/document-templates and select the cardiology template for the next consult-note generation

AI Agent Clinical Q&A

A clinician asks an AI agent 'what symptoms did the patient mention in this morning's visit?'. Through Jentic, the agent calls /sessions/{session_id}/ask-ai with the session id and returns Heidi's grounded answer drawn from the session transcript, without exposing the API key.

Search Jentic for 'ask ai a question about a heidi session', load POST /sessions/{session_id}/ask-ai, and submit the clinician's question

Key Endpoints

29 endpoints — heidi health provides an ai medical scribe that listens to clinician-patient consultations and produces structured notes.

METHOD

PATH

DESCRIPTION

POST

/api/v2/ml-scribe/open-api/sessions

Create a new scribe session

GET

/api/v2/ml-scribe/open-api/sessions/{session_id}

Get session details

POST

/api/v2/ml-scribe/open-api/sessions/{session_id}/consult-note

Generate a consult note from the session

GET

/api/v2/ml-scribe/open-api/sessions/{session_id}/transcript

Get the session transcript

GET

/api/v2/ml-scribe/open-api/sessions/{session_id}/clinical-codes

Get extracted clinical codes

POST

/api/v2/ml-scribe/open-api/sessions/{session_id}/ask-ai

Ask an AI question grounded in the session

GET

/api/v2/ml-scribe/open-api/jwt

Mint a session JWT from the API key

GET

/api/v2/ml-scribe/open-api/templates/document-templates

List document templates

POST

/api/v2/ml-scribe/open-api/sessions

Create a new scribe session

GET

/api/v2/ml-scribe/open-api/sessions/{session_id}

Get session details

POST

/api/v2/ml-scribe/open-api/sessions/{session_id}/consult-note

Generate a consult note from the session

GET

/api/v2/ml-scribe/open-api/sessions/{session_id}/transcript

Get the session transcript

GET

/api/v2/ml-scribe/open-api/sessions/{session_id}/clinical-codes

Get extracted clinical codes

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

The Heidi API key is held in the Jentic vault. Jentic performs the JWT exchange against /jwt at execution time, so the agent only ever sees a short-lived bearer token scoped to the current session.

Intent-based discovery

Agents search by intent (e.g. 'create a scribe session' or 'generate a consult note') and Jentic returns the matching Heidi operation with its body schema and the required path parameters.

Time to first call

Direct integration: 1-2 days to wire up JWT minting, segment uploads, and consult-note generation. Through Jentic: under an hour — search, load, execute the chain.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

DrChrono API

DrChrono provides the EHR system to which Heidi-generated notes are typically written

Use DrChrono to persist the consult note into a patient chart; use Heidi to generate the note in the first place

Complementary

Athenahealth API

Athenahealth is another EHR target for Heidi-generated notes and codes

Pick Athenahealth when the practice runs on athenaOne; use Heidi to produce the structured note that Athenahealth ingests

Alternative

Deepgram API

Deepgram offers raw speech-to-text but lacks the consult-note and clinical-code layers Heidi provides

Choose Deepgram if you only need transcription; choose Heidi when structured clinical notes and codes are required

Alternative

AssemblyAI API

AssemblyAI is a generic transcription and audio intelligence API, broader but less clinical than Heidi

Use AssemblyAI for general-purpose audio AI; use Heidi when the workflow is specifically a clinical scribe

FAQs

Specific to using Heidi API Documentation API through Jentic.

What authentication does the Heidi API use?

Heidi uses an API key to call GET /api/v2/ml-scribe/open-api/jwt, which returns a JWT that is then used as a Bearer token on per-session endpoints. Through Jentic, the API key is held in the encrypted vault and the JWT exchange happens at execution time.

Can I generate a consult note from a recorded session?

Yes. POST /api/v2/ml-scribe/open-api/sessions/{session_id}/consult-note generates a structured note from the session's transcript, optionally using a chosen document template id.

What are the rate limits for the Heidi API?

The OpenAPI spec does not publish hard rate limits; Heidi applies plan-level fair use. Because audio transcription is the heavy operation, batch segment uploads rather than firing many small segments per second.

How do I create a session and ask the AI a question through Jentic?

Run pip install jentic, have the agent search for 'create a heidi scribe session', load the session-creation operation, then chain to POST /sessions/{session_id}/ask-ai with the clinician's question.

Does Heidi return clinical codes for a session?

Yes. GET /api/v2/ml-scribe/open-api/sessions/{session_id}/clinical-codes returns the clinical codes inferred from the consultation, which a coder or billing system can review before submission.

Can I customise the consult-note template?

Yes. List document templates with GET /api/v2/ml-scribe/open-api/templates/document-templates and pass the selected template id when generating the consult note, or use the client-customised-template endpoint for tailored output.