Skip to content
Avara
Get started
API Reference
Auto Scribe

Studies

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
PriorReport = object { reportText, externalStudyId, modality, 2 more }

External prior report metadata and text stored on a study

reportText: string

Full prior report text

minLength1
maxLength50000
externalStudyId: optional string

Integrator's external study identifier

minLength1
maxLength256
modality: optional string

Imaging modality for the prior study

minLength1
maxLength100
studyDate: optional string

Prior study date (YYYY-MM-DD)

studyDescription: optional string

Description of the prior study

minLength1
maxLength1000
ReportIDWithStatus = object { isCritical, reportId, status }

A report ID paired with its current status

isCritical: boolean

Whether the report was marked critical at sign-off. null when the report is not yet completed; true/false once completed.

reportId: string

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

status: ReportStatus

Status of an individual report. 'in_progress' = actively being dictated, 'completed' = signed.

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