API Reference

Viewer

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Studies

Create a new study

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

post/v1/viewer/studies

List studies with pagination

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

get/v1/viewer/studies

Retrieve a study by ID

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

get/v1/viewer/studies/{studyId}

Update a study

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

patch/v1/viewer/studies/{studyId}

Cancel a study

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

post/v1/viewer/studies/cancel

Uncancel a study

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

post/v1/viewer/studies/uncancel

Generate a viewer reroute URL

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

post/v1/viewer/studies/reroute-url

Retrieve a study by DICOM UID

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

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