Skip to content
Avara
Get started
API Reference

Auto Scribe

ModelsExpand Collapse
StudyReportMetadata = object { age, dateOfBirth, facilityName, 9 more }

Patient demographics and scan information for report generation

age: optional string

Patient's age at time of scan (e.g., '34.5 years', '2 months')

dateOfBirth: optional string

Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20')

facilityName: optional string

Name of the medical facility where the scan was performed

height: optional object { unit, value }

Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'})

unit: "in" or "cm"
Accepts one of the following:
"in"
"cm"
value: number
minimum0
mrn: optional string

Medical Record Number - unique patient identifier

patientName: optional string

Full name of the patient

referringPhysicianName: optional string

Name of the physician who referred the patient for this scan

scanDate: optional string

Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15')

scanTime: optional string

Time the scan was performed. Format: HH:MM (e.g., '14:30')

scanType: optional string

Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound')

sex: optional "male" or "female" or "other"

Patient's biological sex. Options: 'male', 'female', 'other'

Accepts one of the following:
"male"
"female"
"other"
weight: optional object { unit, value }

Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'})

unit: "lbs" or "kg"
Accepts one of the following:
"lbs"
"kg"
value: number
minimum0

Auto ScribeStudies

Create a new study
POST/v1/autoScribe/studies
List studies with pagination
GET/v1/autoScribe/studies
Retrieve a study by ID
GET/v1/autoScribe/studies/{studyId}
Update a study
PATCH/v1/autoScribe/studies/{studyId}
Cancel a study
POST/v1/autoScribe/studies/cancel
Uncancel a study
POST/v1/autoScribe/studies/uncancel
Generate a reroute URL with viewer and dictation
POST/v1/autoScribe/studies/reroute-url
Generate a viewer-only reroute URL
POST/v1/autoScribe/studies/viewer-only-reroute-url
Retrieve a study by DICOM UID
GET/v1/autoScribe/studies/by-uid/{studyInstanceUid}
ModelsExpand Collapse
ReportIDWithStatus = object { reportId, status }

A report ID paired with its current status

reportId: string

Unique report identifier. Format: rep_{32-hex-chars}

status: "in_progress" or "completed"

Current status of the report

Accepts one of the following:
"in_progress"
"completed"

Auto ScribeUsers

Create and invite a new user
POST/v1/autoScribe/users
List users with pagination
GET/v1/autoScribe/users
Retrieve a user by ID
GET/v1/autoScribe/users/{userId}
Update a user
PATCH/v1/autoScribe/users/{userId}
Revoke user access
POST/v1/autoScribe/users/revoke-access
Reactivate a user
POST/v1/autoScribe/users/reactivate

Auto ScribeUsersInvitations

List user invitations
GET/v1/autoScribe/users/invitations
Retrieve an invitation by ID
GET/v1/autoScribe/users/invitations/{invitationId}
Update an invitation
PATCH/v1/autoScribe/users/invitations/{invitationId}
Revoke an invitation
POST/v1/autoScribe/users/invitations/revoke

Auto ScribeReports

List reports for a study
GET/v1/autoScribe/reports
Retrieve report text
GET/v1/autoScribe/reports/text
Retrieve report PDF URL
GET/v1/autoScribe/reports/pdf
Create a report addendum
POST/v1/autoScribe/reports/{reportId}/addendum
Cancel a report addendum
POST/v1/autoScribe/reports/{reportId}/cancel-addendum