Skip to content
Get started

Generate a viewer-only reroute URL

post/v1/autoScribe/studies/viewer-only-reroute-url

Generates a tokenized URL that redirects users to the viewer interface only (no dictation) for the specified study. Useful for read-only access or referring physicians. The URL includes authentication and is time-limited.

Body ParametersExpand Collapse
studyId: optional string

Unique study identifier. Format: stu_{32-hex-chars}

studyInstanceUid: optional string

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2')

minLength1
userId: optional string

Optional user ID for audit tracking. Format: usr_{32-hex-chars}

ReturnsExpand Collapse
url: string
Generate a viewer-only reroute URL
curl https://api.avarasoftware.com/v1/autoScribe/studies/viewer-only-reroute-url \
    -X POST \
    -H "Authorization: Bearer $AVARA_API_KEY"
{
  "url": "https://viewer.avarasoftware.com/study/stu_1234?token=abc123"
}
Returns Examples
{
  "url": "https://viewer.avarasoftware.com/study/stu_1234?token=abc123"
}