Skip to main content
POST
Regenerate the note

Authorizations

Authorization
string
header
required

Your API key, created in RxNote under Settings → API: Authorization: Bearer rxn_live_….

Path Parameters

id
integer
required
Example:

90211

Body

application/json
template_id
integer

Rewrite the note with this template. Omitted: the visit's current template.

clinician_email
string<email>

Required with an organization key: the RxNote member acting. With a personal key, omit it or send the owner's own email.

Maximum string length: 255
Example:

"doctor@clinic.example"

Response

The visit, now processing.

id
integer
required
Example:

90211

patient_id
integer
required
status
enum<string>
required
Available options:
recording,
pending,
processing,
transcribing,
generating-soap,
completed,
failed,
no-speech
language
string
required
template_id
integer | null
required
outputs
enum<string>[]
required
Available options:
transcript,
note,
summary
created_at
string<date-time>
required
completed_at
string<date-time> | null
required
icd_codes
object | null
required

Set once POST /visits/{id}/icd-codes has run.

error
object | null
required
upload
object

Only while the status is recording (waiting for the audio).

transcript
object | null

Omitted unless requested; null until ready.

note
object | null

Omitted unless requested; null until ready.

summary
object | null

Omitted unless requested; null until ready.