Heidi API

Upload Session Context Documents

upload session context documents

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

Request

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

Path parameters

session_idstring required

Request body multipart/form-data

context_documentsstring[] required

Response

Successful Response

idstring required
user_idstring required
session_idstring required
namestring required
datestring date-time nullable
type'word' | 'pdf' | 'image'
contentstring nullable
status'OVERSIZED' | 'FAIL_TO_UPLOAD' | 'PARSING' | 'FAIL_TO_EXTRACT_CONTENT' | 'READY' | 'READY_WITH_HIGH_TOKEN_COUNT'
additional_contextstring nullable
unstructuredboolean nullable

Changes

No recorded changes to this operation across all 5 revisions of this API.