Skip to main content
POST
Generate a note from the patient's documents

Authorizations

X-API-Key
string
header
required

API key obtained from /api/v1/ext-api-keys

Path Parameters

patientId
string
required
Pattern: ^\d+$
Example:

"481926357104938271"

Body

application/json

Generation options (all fields optional)

template_id
string<uuid>

Template to generate with. Defaults to the clinician's default template. Must be a built-in template or one owned by your organization.

model
enum<string>

Note quality, the same choices as the HealOS dashboard: fast, balanced, or detailed. Defaults to the standard quality.

Available options:
detailed,
balanced,
fast
Example:

"balanced"

Response

Note generation queued

data
object
required
message
string
required