API Reference

Auto Scribe

Studies

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Generate a reroute URL with viewer and dictation

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

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

StudyRerouteUrlParams params

String assignedToUserId

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

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

String url

Generate a reroute URL with viewer and dictation

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.StudyRerouteUrlParams;
import com.avara.models.autoscribe.studies.StudyRerouteUrlResponse;

public final class Main {
    private Main() {}

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

        StudyRerouteUrlParams params = StudyRerouteUrlParams.builder()
            .assignedToUserId("usr_1234567890abcdef1234567890abcdef")
            .build();
        StudyRerouteUrlResponse response = client.autoScribe().studies().rerouteUrl(params);
    }
}

200 example

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

Returns Examples

200 example

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