Generate a viewer-only reroute URL

auto_scribe.studies.viewer_only_reroute_url() -> StudyViewerOnlyRerouteURLResponse

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

study_id: Optional[str]

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

study_instance_uid: Optional[str]

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

minLength1

user_id: Optional[str]

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

ReturnsExpand Collapse

class StudyViewerOnlyRerouteURLResponse: …

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

url: str

Generate a viewer-only reroute URL

import os
from avara import Avara

client = Avara(
    api_key=os.environ.get("AVARA_API_KEY"),  # This is the default and can be omitted
)
response = client.auto_scribe.studies.viewer_only_reroute_url()
print(response.url)

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

Returns Examples

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