Generate a viewer reroute URL

client.viewer.studies.rerouteURL(?, ?): StudyRerouteURLResponse { url }

POST/v1/viewer/studies/reroute-url

Generates a tokenized URL that redirects users directly to the Avara Viewer for the specified study. The URL includes authentication and is time-limited for security.

ParametersExpand Collapse

body: StudyRerouteURLParams { studyId, studyInstanceUid }

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

ReturnsExpand Collapse

StudyRerouteURLResponse { url }

Response containing the generated reroute URL for a study in Viewer

url: string

Generate a viewer 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.viewer.studies.rerouteURL();

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"
}