Skip to content
Avara
Get started
API Reference
Auto Scribe

Studies

Create a new study
auto_scribe.studies.create(StudyCreateParams**kwargs) -> StudyCreateResponse
post/v1/autoScribe/studies
List studies with pagination
auto_scribe.studies.list(StudyListParams**kwargs) -> SyncCursorStudies[StudyListResponse]
get/v1/autoScribe/studies
Retrieve a study by ID
auto_scribe.studies.retrieve(strstudy_id) -> StudyRetrieveResponse
get/v1/autoScribe/studies/{studyId}
Update a study
auto_scribe.studies.update(strstudy_id, StudyUpdateParams**kwargs) -> StudyUpdateResponse
patch/v1/autoScribe/studies/{studyId}
Cancel a study
auto_scribe.studies.cancel(StudyCancelParams**kwargs) -> StudyCancelResponse
post/v1/autoScribe/studies/cancel
Uncancel a study
auto_scribe.studies.uncancel(StudyUncancelParams**kwargs) -> StudyUncancelResponse
post/v1/autoScribe/studies/uncancel
Generate a reroute URL with viewer and dictation
auto_scribe.studies.reroute_url(StudyRerouteURLParams**kwargs) -> StudyRerouteURLResponse
post/v1/autoScribe/studies/reroute-url
Generate a viewer-only reroute URL
auto_scribe.studies.viewer_only_reroute_url(StudyViewerOnlyRerouteURLParams**kwargs) -> StudyViewerOnlyRerouteURLResponse
post/v1/autoScribe/studies/viewer-only-reroute-url
Retrieve a study by DICOM UID
auto_scribe.studies.retrieve_by_uid(strstudy_instance_uid) -> StudyRetrieveByUidResponse
get/v1/autoScribe/studies/by-uid/{studyInstanceUid}
ModelsExpand Collapse
class ReportIDWithStatus: …

A report ID paired with its current status

report_id: str

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

status: Literal["in_progress", "completed"]

Current status of the report

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