API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Viewer

ViewerStudies

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}

ViewerUsers

Create and invite a new user

viewer.users.invite(UserInviteParams**kwargs) -> UserInviteResponse

post/v1/viewer/users

List users with pagination

viewer.users.list(UserListParams**kwargs) -> SyncCursorUsers[UserListResponse]

get/v1/viewer/users

Retrieve a user by ID

viewer.users.retrieve(struser_id) -> UserRetrieveResponse

get/v1/viewer/users/{userId}

Update a user

viewer.users.update(struser_id, UserUpdateParams**kwargs) -> UserUpdateResponse

patch/v1/viewer/users/{userId}

Revoke user access

viewer.users.revoke_access(UserRevokeAccessParams**kwargs) -> UserRevokeAccessResponse

post/v1/viewer/users/revoke-access

Reactivate a user

viewer.users.reactivate(UserReactivateParams**kwargs) -> UserReactivateResponse

post/v1/viewer/users/reactivate

ViewerUsersInvitations

List user invitations

viewer.users.invitations.list(InvitationListParams**kwargs) -> SyncCursorInvitations[InvitationListResponse]

get/v1/viewer/users/invitations

Retrieve an invitation by ID

viewer.users.invitations.retrieve(strinvitation_id) -> InvitationRetrieveResponse

get/v1/viewer/users/invitations/{invitationId}

Update an invitation

viewer.users.invitations.update(strinvitation_id, InvitationUpdateParams**kwargs) -> InvitationUpdateResponse

patch/v1/viewer/users/invitations/{invitationId}

Revoke an invitation

viewer.users.invitations.revoke(InvitationRevokeParams**kwargs) -> InvitationRevokeResponse

post/v1/viewer/users/invitations/revoke