API Reference

Viewer

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Studies

Create a new study

viewer.studies.create(StudyCreateParams**kwargs) -> StudyCreateResponse

post/v1/viewer/studies

List studies with pagination

viewer.studies.list(StudyListParams**kwargs) -> SyncCursorStudies[StudyListResponse]

get/v1/viewer/studies

Retrieve a study by ID

viewer.studies.retrieve(strstudy_id) -> StudyRetrieveResponse

get/v1/viewer/studies/{studyId}

Update a study

viewer.studies.update(strstudy_id, StudyUpdateParams**kwargs) -> StudyUpdateResponse

patch/v1/viewer/studies/{studyId}

Cancel a study

viewer.studies.cancel(StudyCancelParams**kwargs) -> StudyCancelResponse

post/v1/viewer/studies/cancel

Uncancel a study

viewer.studies.uncancel(StudyUncancelParams**kwargs) -> StudyUncancelResponse

post/v1/viewer/studies/uncancel

Generate a viewer reroute URL

viewer.studies.reroute_url(StudyRerouteURLParams**kwargs) -> StudyRerouteURLResponse

post/v1/viewer/studies/reroute-url

Retrieve a study by DICOM UID

viewer.studies.retrieve_by_uid(strstudy_instance_uid) -> StudyRetrieveByUidResponse

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