Skip to main content

Generate a note

POST 
https://us.api.nabla.com/v1/core/server/generate-note

Generate a structured clinical note given the transcript.

Request​

Responses​

The generated note.

Authorization: http

name: bearertype: httpscheme: bearer
curl -L 'https://us.api.nabla.com/v1/core/server/generate-note' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>' \
-d '{
  "note_locale": "ENGLISH_US",
  "transcript_items": [
    {
      "text": "Also, I’m allergic to peanuts.",
      "speaker_type": "DOCTOR"
    }
  ],
  "note_template": "GENERIC_MULTIPLE_SECTIONS",
  "note_sections_customization": [
    {
      "section_key": "CHIEF_COMPLAINT",
      "custom_instruction": "Include discussion about first symptoms",
      "style": "PARAGRAPHS",
      "level_of_detail": "DEFAULT",
      "split_by_problem": true
    }
  ],
  "previous_note": {
    "title": "Fever and strong headache",
    "sections": [
      {
        "key": "CHIEF_COMPLAINT",
        "title": "Chief complaint",
        "text": "Sleep disorder"
      }
    ]
  },
  "patient_context": "string"
}'
Request Collapse all
Base URL
https://us.api.nabla.com/v1/core/server
Auth
Body required
{
  "note_locale": "ENGLISH_US",
  "transcript_items": [
    {
      "text": "Also, I’m allergic to peanuts.",
      "speaker_type": "DOCTOR"
    }
  ],
  "note_template": "GENERIC_MULTIPLE_SECTIONS",
  "note_sections_customization": [
    {
      "section_key": "CHIEF_COMPLAINT",
      "custom_instruction": "Include discussion about first symptoms",
      "style": "PARAGRAPHS",
      "level_of_detail": "DEFAULT",
      "split_by_problem": true
    }
  ],
  "previous_note": {
    "title": "Fever and strong headache",
    "sections": [
      {
        "key": "CHIEF_COMPLAINT",
        "title": "Chief complaint",
        "text": "Sleep disorder"
      }
    ]
  },
  "patient_context": "string"
}
ResponseClear

Click the Send API Request button above and see the response here!