Skip to main content
POST
Generate a note from text

Authorizations

X-API-Key
string
header
required

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

Body

application/json
text
string
required

The visit text: typed notes, a dictation or a transcript. Up to 100,000 characters.

Required string length: 1 - 100000
Example:

"Patient reports knee pain for two weeks, worse on stairs. No swelling. Ibuprofen 400 mg BID. Plan: physiotherapy, follow up in 4 weeks."

patient_id
string

A patient in your organization. Omit it to create a temp (unassigned) session and assign the patient later with PATCH /sessions/{sessionId}.

Pattern: ^\d+$
Example:

"481926357104938271"

template_id
string

Template to generate with. Defaults to the clinician's default template, then New Patient Visit.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
model
enum<string>

Note quality, as on the 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