openapi: 3.1.0
info:
  title: Heidi Health Ask Heidi Consult Notes API
  version: v2
  summary: Public Heidi REST API for ambient AI medical scribe, transcription, consult notes, documents, clinical coding, and Ask Heidi.
  description: 'The Heidi API lets partner platforms (EHRs, telehealth apps, custom clinician

    tools) drive Heidi''s ambient documentation engine end-to-end:

    authentication via tenant API key + per-user JWT, patient profile

    management, session lifecycle (create, update, list, retrieve),

    contextual attachments and linked sessions, audio upload (single file or

    chunked live), transcript retrieval (final or live-chunked), template

    discovery, streamed consult-note and document generation against Heidi

    or custom templates, multi-standard clinical coding (ICD-10/SNOMED/CPT

    and others), and streamed Ask Heidi assistant responses.


    Documentation: https://www.heidihealth.com/developers/heidi-api/overview

    '
  contact:
    name: Heidi Health Support
    url: https://support.heidihealth.com
  license:
    name: Heidi Health Terms of Service
    url: https://www.heidihealth.com/legal/terms-of-service
servers:
- url: https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api
  description: Production
security:
- bearerAuth: []
tags:
- name: Consult Notes
  description: Streamed consult-note generation.
paths:
  /sessions/{session_id}/consult-note:
    post:
      tags:
      - Consult Notes
      summary: Generate Consult Note
      description: Stream a consult note generated from the session's transcript and context.
      operationId: generateConsultNote
      parameters:
      - $ref: '#/components/parameters/SessionId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConsultNoteGenerate'
      responses:
        '200':
          description: Streamed consult-note chunks.
          content:
            application/x-ndjson:
              schema:
                $ref: '#/components/schemas/StreamChunk'
  /sessions/{session_id}/client-customised-template/response:
    post:
      tags:
      - Consult Notes
      summary: Generate Custom Template Consult Note
      description: Generate a consult note against a client-supplied JSON template.
      operationId: generateCustomTemplateConsultNote
      parameters:
      - $ref: '#/components/parameters/SessionId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                template:
                  type: object
                content_type:
                  type: string
                  enum:
                  - MARKDOWN
                  - HTML
      responses:
        '200':
          description: Generated structured response.
          content:
            application/json:
              schema:
                type: object
components:
  schemas:
    StreamChunk:
      type: object
      properties:
        data:
          type: string
    ConsultNoteGenerate:
      type: object
      required:
      - generation_method
      - addition
      - voice_style
      - brain
      properties:
        generation_method:
          type: string
          enum:
          - TEMPLATE
        template_id:
          type: string
        addition:
          type: string
        voice_style:
          type: string
          enum:
          - GOLDILOCKS
          - DETAILED
          - BRIEF
          - SUPER_DETAILED
          - MY_VOICE
        brain:
          type: string
          enum:
          - LEFT
          - RIGHT
          default: LEFT
        content_type:
          type: string
          enum:
          - MARKDOWN
          - HTML
  parameters:
    SessionId:
      in: path
      name: session_id
      required: true
      schema:
        type: string
  securitySchemes:
    heidiApiKey:
      type: apiKey
      in: header
      name: Heidi-Api-Key
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT