Skip to main content

Generate a note asynchronously

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

Creates an asynchronous task (also called asynchronous request) that will generate a structured clinical note given the transcript, then keeps the response for a short period to be fetched using the poll endpoint.

The generated note will be localized to the user's language and can be customized using the user's note generation settings and template-specific per-section customization options. Customization includes adjusting the level of detail, organizing content by problem, and other formatting preferences.

Request​

Responses​

Request received and processing started.

Authorization: http

name: bearertype: httpscheme: bearer
curl -L 'https://us.api.nabla.com/v1/core/user/generate-note-async' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>' \
-d '{
  "transcript_items": [
    {
      "text": "Also, I’m allergic to peanuts.",
      "speaker_type": "DOCTOR"
    }
  ],
  "previous_note": {
    "title": "Fever and strong headache",
    "sections": [
      {
        "key": "CHIEF_COMPLAINT",
        "title": "Chief complaint",
        "text": "Sleep disorder"
      }
    ]
  },
  "patient_context": "string",
  "structured_context": {
    "active_encounter_diagnoses_coding": [
      {
        "system": "http://hl7.org/fhir/sid/icd-10-cm",
        "code": "G44.8",
        "display": "Other specified headache syndromes."
      }
    ]
  },
  "client_request_id": "string"
}'
Request Collapse all
Base URL
https://us.api.nabla.com/v1/core/user
Auth
Body required
{
  "transcript_items": [
    {
      "text": "Also, I’m allergic to peanuts.",
      "speaker_type": "DOCTOR"
    }
  ],
  "previous_note": {
    "title": "Fever and strong headache",
    "sections": [
      {
        "key": "CHIEF_COMPLAINT",
        "title": "Chief complaint",
        "text": "Sleep disorder"
      }
    ]
  },
  "patient_context": "string",
  "structured_context": {
    "active_encounter_diagnoses_coding": [
      {
        "system": "http://hl7.org/fhir/sid/icd-10-cm",
        "code": "G44.8",
        "display": "Other specified headache syndromes."
      }
    ]
  },
  "client_request_id": "string"
}
ResponseClear

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