Generate a reroute URL with viewer and dictation

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

POST/v1/autoScribe/studies/reroute-url

Generates a tokenized URL that redirects users to the AutoScribe interface (viewer + dictation) for the specified study and user. The URL includes authentication and is time-limited for security.

ParametersExpand Collapse

body: StudyRerouteURLParams { assignedToUserId, studyId, studyInstanceUid }

assignedToUserId: string

User ID to assign study to. Format: usr_{32-hex-chars}

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 AutoScribe (viewer + dictation)

url: string

Generate a reroute URL with viewer and dictation

import Avara from 'avara';

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

const response = await client.autoScribe.studies.rerouteURL({
  assignedToUserId: 'usr_1234567890abcdef1234567890abcdef',
});

console.log(response.url);

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

Returns Examples

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