Skip to content
Avara
Get started
Overview

API Reference

Libraries

TypeScript
0.0.1
npm install git+ssh://git@github.com:stainless-sdks/avara-typescript.git
Read Docs
Python
0.0.1
pip install git+ssh://git@github.com/stainless-sdks/avara-python.git
Read Docs
Java
0.0.1
implementation("com.avara:avara-java:0.0.1")
Read Docs

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

Orgs

Create a new organization
post/v1/orgs
List organizations with pagination
get/v1/orgs
Retrieve an organization by ID
get/v1/orgs/{orgId}
Update an organization
patch/v1/orgs/{orgId}
Deactivate an organization
post/v1/orgs/{orgId}/deactivate
Reactivate an organization
post/v1/orgs/{orgId}/reactivate

OrgsUsers

Add a user to an organization
post/v1/orgs/{orgId}/users
Remove a user from an organization
delete/v1/orgs/{orgId}/users

Webhooks