API Reference

Auto Scribe

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Studies

Create a new study

StudyCreateResponse autoScribe().studies().create(StudyCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

post/v1/autoScribe/studies

List studies with pagination

StudyListPage autoScribe().studies().list(StudyListParamsparams = StudyListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

get/v1/autoScribe/studies

Retrieve a study by ID

StudyRetrieveResponse autoScribe().studies().retrieve(StudyRetrieveParamsparams = StudyRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

get/v1/autoScribe/studies/{studyId}

Update a study

StudyUpdateResponse autoScribe().studies().update(StudyUpdateParamsparams = StudyUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

patch/v1/autoScribe/studies/{studyId}

Cancel a study

StudyCancelResponse autoScribe().studies().cancel(StudyCancelParamsparams = StudyCancelParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

post/v1/autoScribe/studies/cancel

Uncancel a study

StudyUncancelResponse autoScribe().studies().uncancel(StudyUncancelParamsparams = StudyUncancelParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

post/v1/autoScribe/studies/uncancel

Generate a reroute URL with viewer and dictation

StudyRerouteUrlResponse autoScribe().studies().rerouteUrl(StudyRerouteUrlParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

post/v1/autoScribe/studies/reroute-url

Generate a viewer-only reroute URL

StudyViewerOnlyRerouteUrlResponse autoScribe().studies().viewerOnlyRerouteUrl(StudyViewerOnlyRerouteUrlParamsparams = StudyViewerOnlyRerouteUrlParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

post/v1/autoScribe/studies/viewer-only-reroute-url

Retrieve a study by DICOM UID

StudyRetrieveByUidResponse autoScribe().studies().retrieveByUid(StudyRetrieveByUidParamsparams = StudyRetrieveByUidParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

get/v1/autoScribe/studies/by-uid/{studyInstanceUid}

ModelsExpand Collapse

class ReportIdWithStatus:

A report ID paired with its current status

String reportId

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

Status status

Current status of the report

Accepts one of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")