Generate a viewer-only reroute URL

client.autoScribe.studies.viewerOnlyRerouteURL(?, ?): StudyViewerOnlyRerouteURLResponse { 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.

ParametersExpand Collapse

body: StudyViewerOnlyRerouteURLParams { studyId, studyInstanceUid, userId }

studyId?: string

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

studyInstanceUid?: 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?: string

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

ReturnsExpand Collapse

StudyViewerOnlyRerouteURLResponse { url }

Response containing the generated viewer-only reroute URL. Requires viewer to be configured.

url: string

Generate a viewer-only reroute URL

import Avara from 'avara-software';

const client = new Avara({
  apiKey: process.env['AVARA_API_KEY'], // This is the default and can be omitted
});

const response = await client.autoScribe.studies.viewerOnlyRerouteURL();

console.log(response.url);

{
  "url": "https://viewer.avarasoftware.com/study/stu_1234?token=abc123"
}

Returns Examples

{
  "url": "https://viewer.avarasoftware.com/study/stu_1234?token=abc123"
}