Heidi Health · Capability

Heidi Health — Consult Notes

Heidi Health Consult Notes API. Generate streamed consult notes from a session using Heidi or custom JSON templates with voice-style and brain controls. Lead operation: Generate Consult Note.

Heidi Health — Consult Notes is a Naftiko capability published by Heidi Health, one of 10 capabilities the APIs.io network indexes for this provider. It bundles 2 operations across the POST method rooted at /v1/sessions/{…}.

The capability includes 2 state-changing operations. Lead operation: Generate a streamed Heidi consult note. Can be deployed as a REST endpoint, MCP tool, or Agent Skill via Naftiko.

Tagged areas include Heidi Health, Consult Notes, Generation, and Streaming.

Run with Naftiko Heidi HealthConsult NotesGenerationStreaming

What You Can Do

POST
Generateconsultnote —
/v1/sessions/{session_id}/consult-note
POST
Generatecustomtemplateconsultnote —
/v1/sessions/{session_id}/client-customised-template/response

MCP Tools

heidi-generate-consult-note

Generate a streamed Heidi consult note.

heidi-generate-custom-template-consult-note

Generate consult note against a custom JSON template.

Capability Spec

consult-notes.yaml Raw ↑ 
naftiko: 1.0.0-alpha2
info:
  label: Heidi Health — Consult Notes
  description: 'Heidi Health Consult Notes API. Generate streamed consult notes from a session using Heidi or custom JSON templates with voice-style and brain controls. Lead operation: Generate Consult Note.'
  tags:
    - Heidi Health
    - Consult Notes
    - Generation
    - Streaming
  created: '2026-05-24'
  modified: '2026-05-24'
binds:
  - namespace: env
    keys:
      HEIDI_BEARER_TOKEN: HEIDI_BEARER_TOKEN
capability:
  consumes:
    - type: http
      namespace: heidi-consult-notes
      baseUri: https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api
      description: Heidi Health consult-note generation surface.
      resources:
        - name: consultNote
          path: /sessions/{session_id}/consult-note
          operations:
            - name: generateConsultNote
              method: POST
              description: Generate a streamed consult note.
              outputRawFormat: ndjson
              outputParameters:
                - name: stream
                  type: stream
                  value: $.
              inputParameters:
                - name: session_id
                  in: path
                  type: string
                  required: true
                - name: body
                  in: body
                  type: object
                  required: true
        - name: customTemplate
          path: /sessions/{session_id}/client-customised-template/response
          operations:
            - name: generateCustomTemplateConsultNote
              method: POST
              description: Generate consult note against a custom JSON template.
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: session_id
                  in: path
                  type: string
                  required: true
                - name: body
                  in: body
                  type: object
                  required: true
      authentication:
        type: bearer
        value: '{{env.HEIDI_BEARER_TOKEN}}'
  exposes:
    - type: rest
      namespace: heidi-consult-notes-rest
      port: 8080
      description: REST adapter for Heidi Consult Notes.
      resources:
        - path: /v1/sessions/{session_id}/consult-note
          name: consultNote
          operations:
            - method: POST
              name: generateConsultNote
              call: heidi-consult-notes.generateConsultNote
              with:
                session_id: rest.path.session_id
                body: rest.body
              outputParameters:
                - type: stream
                  mapping: $.
        - path: /v1/sessions/{session_id}/client-customised-template/response
          name: customTemplate
          operations:
            - method: POST
              name: generateCustomTemplateConsultNote
              call: heidi-consult-notes.generateCustomTemplateConsultNote
              with:
                session_id: rest.path.session_id
                body: rest.body
              outputParameters:
                - type: object
                  mapping: $.
    - type: mcp
      namespace: heidi-consult-notes-mcp
      port: 9090
      transport: http
      description: MCP adapter for Heidi Consult Notes.
      tools:
        - name: heidi-generate-consult-note
          description: Generate a streamed Heidi consult note.
          hints:
            readOnly: false
            destructive: false
            idempotent: false
          call: heidi-consult-notes.generateConsultNote
          with:
            session_id: tools.session_id
            body: tools.body
          outputParameters:
            - type: stream
              mapping: $.
        - name: heidi-generate-custom-template-consult-note
          description: Generate consult note against a custom JSON template.
          hints:
            readOnly: false
            destructive: false
            idempotent: false
          call: heidi-consult-notes.generateCustomTemplateConsultNote
          with:
            session_id: tools.session_id
            body: tools.body
          outputParameters:
            - type: object
              mapping: $.