HEheidihealth
Heidi API

Get Documents

Changed on

get all documents for session

get/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

Query parameters

sort_by'created_at' | 'index'
sort_order'ASC' | 'DESC'
skipinteger
limitinteger nullable

Response

Successful Response

Example response

{
  "documents": [
    {
      "id": "5eb7cf5a86d9755df3a6c593",
      "template_id": "5eb7cf5a86d9755df3a6c593",
      "ai_command_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