Skip to content
Get started

Studies

Create a new study
StudyCreateResponse AutoScribe.Studies.Create(StudyCreateParamsparameters, CancellationTokencancellationToken = default)
POST/v1/autoScribe/studies
List studies with pagination
StudyListPageResponse AutoScribe.Studies.List(StudyListParams?parameters, CancellationTokencancellationToken = default)
GET/v1/autoScribe/studies
Retrieve a study by ID
StudyRetrieveResponse AutoScribe.Studies.Retrieve(StudyRetrieveParamsparameters, CancellationTokencancellationToken = default)
GET/v1/autoScribe/studies/{studyId}
Update a study
StudyUpdateResponse AutoScribe.Studies.Update(StudyUpdateParamsparameters, CancellationTokencancellationToken = default)
PATCH/v1/autoScribe/studies/{studyId}
Cancel a study
StudyCancelResponse AutoScribe.Studies.Cancel(StudyCancelParams?parameters, CancellationTokencancellationToken = default)
POST/v1/autoScribe/studies/cancel
Uncancel a study
StudyUncancelResponse AutoScribe.Studies.Uncancel(StudyUncancelParams?parameters, CancellationTokencancellationToken = default)
POST/v1/autoScribe/studies/uncancel
Generate a reroute URL with viewer and dictation
StudyRerouteUrlResponse AutoScribe.Studies.RerouteUrl(StudyRerouteUrlParamsparameters, CancellationTokencancellationToken = default)
POST/v1/autoScribe/studies/reroute-url
Generate a viewer-only reroute URL
StudyViewerOnlyRerouteUrlResponse AutoScribe.Studies.ViewerOnlyRerouteUrl(StudyViewerOnlyRerouteUrlParams?parameters, CancellationTokencancellationToken = default)
POST/v1/autoScribe/studies/viewer-only-reroute-url
Retrieve a study by DICOM UID
StudyRetrieveByUidResponse AutoScribe.Studies.RetrieveByUid(StudyRetrieveByUidParamsparameters, CancellationTokencancellationToken = default)
GET/v1/autoScribe/studies/by-uid/{studyInstanceUid}
ModelsExpand Collapse
class ReportIDWithStatus:

A report ID paired with its current status

required string ReportID

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

required Status Status

Current status of the report

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