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

StudyRerouteUrlResponse viewer().studies().rerouteUrl(StudyRerouteUrlParamsparams = StudyRerouteUrlParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

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

StudyRerouteUrlParams params

Optional<String> studyId

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

Optional<String> studyInstanceUid

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

String url

Generate a viewer reroute URL

Java

HTTP

TypeScript

Python

Java

package com.avara.example;

import com.avara.client.AvaraClient;
import com.avara.client.okhttp.AvaraOkHttpClient;
import com.avara.models.viewer.studies.StudyRerouteUrlParams;
import com.avara.models.viewer.studies.StudyRerouteUrlResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AvaraClient client = AvaraOkHttpClient.fromEnv();

        StudyRerouteUrlResponse response = client.viewer().studies().rerouteUrl();
    }
}

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