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
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"