API Reference

Auto Scribe

Studies

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Generate a viewer-only reroute URL

StudyViewerOnlyRerouteUrlResponse autoScribe().studies().viewerOnlyRerouteUrl(StudyViewerOnlyRerouteUrlParamsparams = StudyViewerOnlyRerouteUrlParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

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

StudyViewerOnlyRerouteUrlParams 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

Optional<String> userId

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.

String url

Generate a viewer-only 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.autoscribe.studies.StudyViewerOnlyRerouteUrlParams;
import com.avara.models.autoscribe.studies.StudyViewerOnlyRerouteUrlResponse;

public final class Main {
    private Main() {}

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

        StudyViewerOnlyRerouteUrlResponse response = client.autoScribe().studies().viewerOnlyRerouteUrl();
    }
}

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