API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Viewer

ViewerStudies

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}

ViewerUsers

Create and invite a new user

UserInviteResponse viewer().users().invite(UserInviteParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

post/v1/viewer/users

List users with pagination

UserListPage viewer().users().list(UserListParamsparams = UserListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

get/v1/viewer/users

Retrieve a user by ID

UserRetrieveResponse viewer().users().retrieve(UserRetrieveParamsparams = UserRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

get/v1/viewer/users/{userId}

Update a user

UserUpdateResponse viewer().users().update(UserUpdateParamsparams = UserUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

patch/v1/viewer/users/{userId}

Revoke user access

UserRevokeAccessResponse viewer().users().revokeAccess(UserRevokeAccessParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

post/v1/viewer/users/revoke-access

Reactivate a user

UserReactivateResponse viewer().users().reactivate(UserReactivateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

post/v1/viewer/users/reactivate

ViewerUsersInvitations

List user invitations

InvitationListPage viewer().users().invitations().list(InvitationListParamsparams = InvitationListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

get/v1/viewer/users/invitations

Retrieve an invitation by ID

InvitationRetrieveResponse viewer().users().invitations().retrieve(InvitationRetrieveParamsparams = InvitationRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

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

Update an invitation

InvitationUpdateResponse viewer().users().invitations().update(InvitationUpdateParamsparams = InvitationUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

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

Revoke an invitation

InvitationRevokeResponse viewer().users().invitations().revoke(InvitationRevokeParamsparams = InvitationRevokeParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

post/v1/viewer/users/invitations/revoke