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

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

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

assigned_to_user_id: str

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

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

url: str

Generate a reroute URL with viewer and dictation

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.auto_scribe.studies.reroute_url(
    assigned_to_user_id="usr_1234567890abcdef1234567890abcdef",
)
print(response.url)

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