Skip to content
Avara
Get started
API Reference

Auto Scribe

ModelsExpand Collapse
class StudyReportMetadata: …

Patient demographics and scan information for report generation

age: Optional[str]

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

date_of_birth: Optional[str]

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

facility_name: Optional[str]

Name of the medical facility where the scan was performed

height: Optional[Height]

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

unit: Literal["in", "cm"]
Accepts one of the following:
"in"
"cm"
value: float
minimum0
mrn: Optional[str]

Medical Record Number - unique patient identifier

patient_name: Optional[str]

Full name of the patient

referring_physician_name: Optional[str]

Name of the physician who referred the patient for this scan

scan_date: Optional[str]

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

scan_time: Optional[str]

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

scan_type: Optional[str]

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

sex: Optional[Literal["male", "female", "other"]]

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

Accepts one of the following:
"male"
"female"
"other"
weight: Optional[Weight]

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

unit: Literal["lbs", "kg"]
Accepts one of the following:
"lbs"
"kg"
value: float
minimum0

Auto ScribeStudies

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"

Auto ScribeUsers

Create and invite a new user
auto_scribe.users.invite(UserInviteParams**kwargs) -> UserInviteResponse
post/v1/autoScribe/users
List users with pagination
auto_scribe.users.list(UserListParams**kwargs) -> SyncCursorUsers[UserListResponse]
get/v1/autoScribe/users
Retrieve a user by ID
auto_scribe.users.retrieve(struser_id) -> UserRetrieveResponse
get/v1/autoScribe/users/{userId}
Update a user
auto_scribe.users.update(struser_id, UserUpdateParams**kwargs) -> UserUpdateResponse
patch/v1/autoScribe/users/{userId}
Revoke user access
auto_scribe.users.revoke_access(UserRevokeAccessParams**kwargs) -> UserRevokeAccessResponse
post/v1/autoScribe/users/revoke-access
Reactivate a user
auto_scribe.users.reactivate(UserReactivateParams**kwargs) -> UserReactivateResponse
post/v1/autoScribe/users/reactivate

Auto ScribeUsersInvitations

List user invitations
auto_scribe.users.invitations.list(InvitationListParams**kwargs) -> SyncCursorInvitations[InvitationListResponse]
get/v1/autoScribe/users/invitations
Retrieve an invitation by ID
auto_scribe.users.invitations.retrieve(strinvitation_id) -> InvitationRetrieveResponse
get/v1/autoScribe/users/invitations/{invitationId}
Update an invitation
auto_scribe.users.invitations.update(strinvitation_id, InvitationUpdateParams**kwargs) -> InvitationUpdateResponse
patch/v1/autoScribe/users/invitations/{invitationId}
Revoke an invitation
auto_scribe.users.invitations.revoke(InvitationRevokeParams**kwargs) -> InvitationRevokeResponse
post/v1/autoScribe/users/invitations/revoke

Auto ScribeReports

List reports for a study
auto_scribe.reports.list(ReportListParams**kwargs) -> ReportListResponse
get/v1/autoScribe/reports
Retrieve report text
auto_scribe.reports.text(ReportTextParams**kwargs) -> ReportTextResponse
get/v1/autoScribe/reports/text
Retrieve report PDF URL
auto_scribe.reports.pdf(ReportPdfParams**kwargs) -> ReportPdfResponse
get/v1/autoScribe/reports/pdf
Create a report addendum
auto_scribe.reports.addendum(strreport_id) -> ReportAddendumResponse
post/v1/autoScribe/reports/{reportId}/addendum
Cancel a report addendum
auto_scribe.reports.cancel_addendum(strreport_id) -> ReportCancelAddendumResponse
post/v1/autoScribe/reports/{reportId}/cancel-addendum