HEheidihealth
Heidi API

Create Empty Document

Changed on

create an empty document for the session. This document is a placeholder for the AI generation in next step. Args: session_id (str)

Returns: Document

post/api/v2/ml-scribe/open-api/sessions/{session_id}/documents

Request

  • Base URL
    https://au.api.heidihealth.com
  • Auth
    HTTP bearer

Path parameters

session_idstring required

Request body

document_tab_type'DOCUMENT' | 'DICTATION' | 'PDF'
generation_method'TEMPLATE' | 'THIRD_PARTY_TEMPLATE' | 'DICTATION' | 'AUTO_MODE' required
template_idstring nullable
voice_style'BRIEF' | 'GOLDILOCKS' | 'DETAILED' | 'MY_VOICE' | 'SUPER_DETAILED'

was called writing style

ai_command_idstring nullable
ai_command_textstring nullable
dictation_cleanup_mode'SMART' | 'WORD_FOR_WORD'
brain'LEFT' | 'RIGHT'

Brain enum for different AI model configurations.

Each brain represents a different AI model configuration with specific characteristics:

  • LEFT: Fast and simple model
  • RIGHT: Creative and artistic model
indexinteger nullable
content_type'MARKDOWN'
live_dictation_textstring nullable
is_personalization_appliedboolean nullable
is_not_regenerationboolean nullable
task_idstring nullable

Example request

{
  "template_id": "5eb7cf5a86d9755df3a6c593",
  "ai_command_id": "5eb7cf5a86d9755df3a6c593",
  "task_id": "5eb7cf5a86d9755df3a6c593"
}

Response

Successful Response

idstring required
session_idstring required
creator_kinde_idstring nullable
document_tab_type'DOCUMENT' | 'DICTATION' | 'PDF'
indexinteger nullable
namestring nullable
template_idstring nullable
ai_command_idstring nullable
ai_command_textstring nullable
dictation_cleanup_mode'SMART' | 'WORD_FOR_WORD'
questionstring nullable
original_contentstring nullable
contentstring nullable
updated_dictationstring nullable
created_atstring date-time
updated_atstring date-time
deleted_atstring date-time nullable
generation_type'TEMPLATE' | 'DICTATION' | 'ASK_AI' | 'BLANK'

Stored generation type on a document. Create and generate-content use generation_method instead.

brain'LEFT' | 'RIGHT'

Brain enum for different AI model configurations.

Each brain represents a different AI model configuration with specific characteristics:

  • LEFT: Fast and simple model
  • RIGHT: Creative and artistic model
voice_style'BRIEF' | 'GOLDILOCKS' | 'DETAILED' | 'MY_VOICE' | 'SUPER_DETAILED'

was called writing style

content_type'MARKDOWN'
generation_timestring nullable

successful note generation time string in utc timezone, iso8601 format

is_personalization_appliedboolean nullable
has_deducted_quotaboolean

Tracks whether quota has been deducted for this document. Prevents multiple quota deductions on regeneration. Resets on template ID change.

task_idstring nullable

Example response

{
  "id": "5eb7cf5a86d9755df3a6c593",
  "template_id": "5eb7cf5a86d9755df3a6c593",
  "ai_command_id": "5eb7cf5a86d9755df3a6c593",
  "task_id": "5eb7cf5a86d9755df3a6c593"
}

Changes

  • 353da1bac96fRevision changes
    • warning

      added the new ASK_AI enum value to the / response property for the response status

    • warning

      added the new BLANK enum value to the / response property for the response status

    • warning

      added the new DICTATION enum value to the / response property for the response status

    • info

      added the new AUTO_MODE enum value to the request property

    • info

      added the new DICTATION enum value to the request property