Heidi Health — Transcription

naftiko: 1.0.0-alpha2
info:
  label: Heidi Health — Transcription
  description: 'Heidi Health Transcription API. Upload audio (single file or live chunked) and retrieve final or live chunked transcripts. Lead operation: Upload Session Audio.'
  tags:
    - Heidi Health
    - Transcription
    - Audio
    - Ambient AI
  created: '2026-05-24'
  modified: '2026-05-24'
binds:
  - namespace: env
    keys:
      HEIDI_BEARER_TOKEN: HEIDI_BEARER_TOKEN
capability:
  consumes:
    - type: http
      namespace: heidi-transcription
      baseUri: https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api
      description: Heidi Health transcription surface.
      resources:
        - name: uploadAudio
          path: /sessions/{session_id}/upload-audio
          operations:
            - name: uploadSessionAudio
              method: POST
              description: Upload audio for a session (lazy transcription).
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: session_id
                  in: path
                  type: string
                  required: true
                - name: file
                  in: body
                  type: file
                  required: true
        - name: transcript
          path: /sessions/{session_id}/transcript
          operations:
            - name: getSessionTranscript
              method: GET
              description: Retrieve final transcript.
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: session_id
                  in: path
                  type: string
                  required: true
        - name: liveTranscript
          path: /sessions/{session_id}/transcript/live
          operations:
            - name: getLiveSessionTranscript
              method: GET
              description: Retrieve live chunked transcript with per-chunk status.
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: session_id
                  in: path
                  type: string
                  required: true
      authentication:
        type: bearer
        value: '{{env.HEIDI_BEARER_TOKEN}}'
  exposes:
    - type: rest
      namespace: heidi-transcription-rest
      port: 8080
      description: REST adapter for Heidi Transcription.
      resources:
        - path: /v1/sessions/{session_id}/upload-audio
          name: uploadAudio
          operations:
            - method: POST
              name: uploadSessionAudio
              call: heidi-transcription.uploadSessionAudio
              with:
                session_id: rest.path.session_id
                file: rest.body.file
              outputParameters:
                - type: object
                  mapping: $.
        - path: /v1/sessions/{session_id}/transcript
          name: transcript
          operations:
            - method: GET
              name: getSessionTranscript
              call: heidi-transcription.getSessionTranscript
              with:
                session_id: rest.path.session_id
              outputParameters:
                - type: object
                  mapping: $.
        - path: /v1/sessions/{session_id}/transcript/live
          name: liveTranscript
          operations:
            - method: GET
              name: getLiveSessionTranscript
              call: heidi-transcription.getLiveSessionTranscript
              with:
                session_id: rest.path.session_id
              outputParameters:
                - type: object
                  mapping: $.
    - type: mcp
      namespace: heidi-transcription-mcp
      port: 9090
      transport: http
      description: MCP adapter for Heidi Transcription.
      tools:
        - name: heidi-upload-session-audio
          description: Upload audio for a Heidi session.
          hints:
            readOnly: false
            destructive: false
            idempotent: false
          call: heidi-transcription.uploadSessionAudio
          with:
            session_id: tools.session_id
            file: tools.file
          outputParameters:
            - type: object
              mapping: $.
        - name: heidi-get-transcript
          description: Get the final transcript for a Heidi session.
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: heidi-transcription.getSessionTranscript
          with:
            session_id: tools.session_id
          outputParameters:
            - type: object
              mapping: $.
        - name: heidi-get-live-transcript
          description: Get the live chunked transcript for a Heidi session.
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: heidi-transcription.getLiveSessionTranscript
          with:
            session_id: tools.session_id
          outputParameters:
            - type: object
              mapping: $.