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 PriorReport:

External prior report metadata and text stored on a study

String reportText

Full prior report text

minLength1

maxLength50000

Optional<String> externalStudyId

Integrator’s external study identifier

minLength1

maxLength256

Optional<String> modality

Imaging modality for the prior study

minLength1

maxLength100

Optional<String> studyDate

Prior study date (YYYY-MM-DD)

Optional<String> studyDescription

Description of the prior study

minLength1

maxLength1000

class ReportIdWithStatus:

A report ID paired with its current status

Optional<Boolean> isCritical

Whether the report was marked critical at sign-off. null when the report is not yet completed; true/false once completed.

String reportId

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

ReportStatus status

Status of an individual report. ‘in_progress’ = actively being dictated, ‘completed’ = signed.

One of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

StudiesExternal

Create an external study

ExternalCreateResponse autoScribe().studies().external().create(ExternalCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/v1/autoScribe/studies/external

Delete an external study

ExternalDeleteResponse autoScribe().studies().external().delete(ExternalDeleteParamsparams = ExternalDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

POST/v1/autoScribe/studies/external/delete

StudiesExternalReports

Attach an external report

ReportCreateResponse autoScribe().studies().external().reports().create(ReportCreateParamsparams = ReportCreateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

POST/v1/autoScribe/studies/external/reports

List external reports

ReportListPage autoScribe().studies().external().reports().list(ReportListParamsparams = ReportListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/autoScribe/studies/external/reports

Retrieve an external report

ReportRetrieveResponse autoScribe().studies().external().reports().retrieve(ReportRetrieveParamsparams = ReportRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/autoScribe/studies/external/reports/{externalReportId}