Heidihealth 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.

Install Jentic One Beta

Connect the Heidi API Documentation to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Heidi API Documentation, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

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

GET STARTED

Start building with Heidi API Documentation API

Explore with Jentic

View OpenAPI Document

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 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.

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.

Heidihealth Heidi API Documentation

Connect the Heidi API Documentation to your agent

Capabilities

Start building with Heidi API Documentation API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs