Heidi Health Session Context API
Notes, linked sessions, and context document attachments.
Heidi Health Session Context 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 Session Context. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 7 JSON Schemas.
This API exposes 3 operations 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Heidi Health Session Context 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 3
Across 1 path, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Notes, linked sessions, and context document attachments.
Schemas 1
The contract defines 1 schema that model the data the API accepts and returns. The most detailed is ContextDocument (5 properties). 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.