Heidi Health Consult Notes API
Streamed consult-note generation.
Heidi Health Consult Notes 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 Consult Notes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 7 JSON Schemas.
This API exposes 2 operations across 2 paths, and defines 2 schemas. 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Heidi Health Consult Notes 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 2
Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.
Streamed consult-note generation.
Schemas 2
The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are ConsultNoteGenerate (6 properties), StreamChunk (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Heidi Health 10
Other APIs Heidi Health publishes across the network.