API Reference

Viewer

Studies

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Generate a viewer reroute URL

viewer.studies.reroute_url(StudyRerouteURLParams**kwargs) -> StudyRerouteURLResponse

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

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

ReturnsExpand Collapse

class StudyRerouteURLResponse: …

Response containing the generated reroute URL for a study in Viewer

url: str

Generate a viewer reroute URL

Python

HTTP

TypeScript

Python

Java

C#

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.viewer.studies.reroute_url()
print(response.url)

200 example

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

Returns Examples

200 example

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