API Reference
Libraries
API Overview
Auto Scribe
Auto ScribeStudies
Create a new study
POST/v1/autoScribe/studies
List studies with pagination
GET/v1/autoScribe/studies
Retrieve a study by ID
GET/v1/autoScribe/studies/{studyId}
Update a study
PATCH/v1/autoScribe/studies/{studyId}
Cancel a study
POST/v1/autoScribe/studies/cancel
Uncancel a study
POST/v1/autoScribe/studies/uncancel
Generate a reroute URL with viewer and dictation
POST/v1/autoScribe/studies/reroute-url
Generate a viewer-only reroute URL
POST/v1/autoScribe/studies/viewer-only-reroute-url
Retrieve a study by DICOM UID
GET/v1/autoScribe/studies/by-uid/{studyInstanceUid}
Auto ScribeUsers
Create and invite a new user
POST/v1/autoScribe/users
List users with pagination
GET/v1/autoScribe/users
Retrieve a user by ID
GET/v1/autoScribe/users/{userId}
Update a user
PATCH/v1/autoScribe/users/{userId}
Revoke user access
POST/v1/autoScribe/users/revoke-access
Reactivate a user
POST/v1/autoScribe/users/reactivate
Auto ScribeUsersInvitations
List user invitations
GET/v1/autoScribe/users/invitations
Retrieve an invitation by ID
GET/v1/autoScribe/users/invitations/{invitationId}
Update an invitation
PATCH/v1/autoScribe/users/invitations/{invitationId}
Revoke an invitation
POST/v1/autoScribe/users/invitations/revoke
Auto ScribeReports
List reports for a study
GET/v1/autoScribe/reports
Retrieve report text
GET/v1/autoScribe/reports/text
Retrieve report PDF URL
GET/v1/autoScribe/reports/pdf
Create a report addendum
POST/v1/autoScribe/reports/{reportId}/addendum
Cancel a report addendum
POST/v1/autoScribe/reports/{reportId}/cancel-addendum
Viewer
ViewerStudies
Create a new study
POST/v1/viewer/studies
List studies with pagination
GET/v1/viewer/studies
Retrieve a study by ID
GET/v1/viewer/studies/{studyId}
Update a study
PATCH/v1/viewer/studies/{studyId}
Cancel a study
POST/v1/viewer/studies/cancel
Uncancel a study
POST/v1/viewer/studies/uncancel
Generate a viewer reroute URL
POST/v1/viewer/studies/reroute-url
Retrieve a study by DICOM UID
GET/v1/viewer/studies/by-uid/{studyInstanceUid}
ViewerUsers
Create and invite a new user
POST/v1/viewer/users
List users with pagination
GET/v1/viewer/users
Retrieve a user by ID
GET/v1/viewer/users/{userId}
Update a user
PATCH/v1/viewer/users/{userId}
Revoke user access
POST/v1/viewer/users/revoke-access
Reactivate a user
POST/v1/viewer/users/reactivate
ViewerUsersInvitations
List user invitations
GET/v1/viewer/users/invitations
Retrieve an invitation by ID
GET/v1/viewer/users/invitations/{invitationId}
Update an invitation
PATCH/v1/viewer/users/invitations/{invitationId}
Revoke an invitation
POST/v1/viewer/users/invitations/revoke
Express
Create a new customer
POST/v1/express
List customers with pagination
GET/v1/express
Retrieve a customer by ID
GET/v1/express/{expressCustomerId}
Update a customer
PATCH/v1/express/{expressCustomerId}
Deactivate a customer
POST/v1/express/{expressCustomerId}/deactivate
Reactivate a customer
POST/v1/express/{expressCustomerId}/reactivate
ExpressUsers
Add a user to a customer
POST/v1/express/{expressCustomerId}/users
Remove a user from a customer
DELETE/v1/express/{expressCustomerId}/users
Webhooks
Unwrap
Function
Unsafe Unwrap
Function