Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Heidi Health Authentication API

Token exchange.

Heidi Health Authentication API is one of 11 APIs that Heidi Health publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 7 JSON Schema definitions.

Tagged areas include Authentication. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 7 JSON Schemas.

This API exposes 1 operation across 1 path, and defines 1 schema. It is described by OpenAPI 3.1.0, at version v2.

Requests are made against a single base URL, https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api.

1 operations 1 paths 1 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v2
Server
https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Heidi Health Authentication API declares 2 security schemes for authenticating requests. An API key is passed in the header as Heidi-Api-Key (heidiApiKey). It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Authentication 1

Token exchange.

GET
/jwt
Exchange API Key For JWT
getJwt 2 params → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Jwt (2 properties). Each schema is shown below with its type and property counts.

Jwt
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

heidi-health-authentication-api-openapi.yml Raw ↑

Other APIs Heidi Health publishes across the network.

Heidi Widget SDK
Heidi Health Ask Heidi API
Heidi Health Clinical Coding API
Heidi Health Consult Notes API
Heidi Health Documents API
Heidi Health Patient Profiles API
Heidi Health Session Context API
Heidi Health Sessions API
Heidi Health Templates API
Heidi Health Transcription API