Heidi Health · Capability

Heidi Health — Ask Heidi

Heidi Health Ask Heidi API. Stream AI-assistant responses scoped to a clinical session. Lead operation: Ask Heidi.

Heidi Health — Ask Heidi is a Naftiko capability published by Heidi Health, one of 10 capabilities the APIs.io network indexes for this provider. It bundles 1 operation across the POST method rooted at /v1/sessions/{…}/ask-ai.

The capability includes 1 state-changing operation. Lead operation: Stream a Heidi AI-assistant response scoped to a session. Can be deployed as a REST endpoint, MCP tool, or Agent Skill via Naftiko.

Tagged areas include Heidi Health, Ask Heidi, Assistant, and Streaming.

Run with Naftiko Heidi HealthAsk HeidiAssistantStreaming

What You Can Do

POST

Askheidi —

/v1/sessions/{session_id}/ask-ai

MCP Tools

heidi-ask

Stream a Heidi AI-assistant response scoped to a session.

Capability Spec

naftiko: 1.0.0-alpha2
info:
  label: Heidi Health — Ask Heidi
  description: 'Heidi Health Ask Heidi API. Stream AI-assistant responses scoped to a clinical session. Lead operation: Ask Heidi.'
  tags:
    - Heidi Health
    - Ask Heidi
    - Assistant
    - 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-ask
      baseUri: https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api
      description: Heidi Health Ask Heidi surface.
      resources:
        - name: askAi
          path: /sessions/{session_id}/ask-ai
          operations:
            - name: askHeidi
              method: POST
              description: Stream an AI-assistant response scoped to the session.
              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
      authentication:
        type: bearer
        value: '{{env.HEIDI_BEARER_TOKEN}}'
  exposes:
    - type: rest
      namespace: heidi-ask-rest
      port: 8080
      description: REST adapter for Heidi Ask Heidi.
      resources:
        - path: /v1/sessions/{session_id}/ask-ai
          name: askAi
          operations:
            - method: POST
              name: askHeidi
              call: heidi-ask.askHeidi
              with:
                session_id: rest.path.session_id
                body: rest.body
              outputParameters:
                - type: stream
                  mapping: $.
    - type: mcp
      namespace: heidi-ask-mcp
      port: 9090
      transport: http
      description: MCP adapter for Heidi Ask Heidi.
      tools:
        - name: heidi-ask
          description: Stream a Heidi AI-assistant response scoped to a session.
          hints:
            readOnly: false
            destructive: false
            idempotent: false
          call: heidi-ask.askHeidi
          with:
            session_id: tools.session_id
            body: tools.body
          outputParameters:
            - type: stream
              mapping: $.