Create an ephemeral AutoScribe viewer session

client.autoScribe.ephemeralSessions.create(, ?): EphemeralSessionCreateResponse { url }

POST/v1/autoScribe/ephemeral-sessions

Mints a 30-second tokenized landing URL for a userless, studyless AutoScribe viewer session. The token names a customer retrievalId (not an Avara study). Optional options are echoed verbatim on ephemeral.access_requested (max 3072 bytes JSON). Optional hangingProtocol applies a single-monitor layout when the viewer loads. Requires a customer study webhook on the API key.

ParametersExpand Collapse

body: EphemeralSessionCreateParams { retrievalId, hangingProtocol, options }

retrievalId: string

Opaque customer handle for this view session. Avara stores and echoes it; it is not an Avara study ID.

minLength1

maxLength1024

hangingProtocol?: EphemeralHangingProtocol { layout, viewportAssignments }

Optional single-monitor hanging protocol applied when the ephemeral viewer loads. Omitted = no protocol. Invalid shape is rejected.

layout: ViewerLayout

Viewport grid layout for an ephemeral hanging protocol. Wire values match first-party viewer layouts (‘1x1’ through ‘4x4’).

One of the following:

"1x1"

"1x2"

"1x3"

"1x4"

"2x1"

"2x2"

"2x3"

"2x4"

"3x1"

"3x2"

"3x3"

"3x4"

"4x1"

"4x2"

"4x3"

"4x4"

viewportAssignments: Array<string | null>

options?: Record<string, unknown>

Optional JSON object echoed verbatim on ephemeral.access_requested. Avara does not read or edit it. Hard cap 3072 bytes on JSON.stringify. Examples: studyInstanceUids or internal ids for multi-study reads. Not for URLs or manifests.

ReturnsExpand Collapse

EphemeralSessionCreateResponse { url }

Tokenized landing URL for an ephemeral AutoScribe viewer session (30-second token).

url: string

Create an ephemeral AutoScribe viewer session

import Avara from 'avara-software';

const client = new Avara({
  apiKey: process.env['AVARA_API_KEY'], // This is the default and can be omitted
});

const ephemeralSession = await client.autoScribe.ephemeralSessions.create({
  retrievalId: 'order-12345',
});

console.log(ephemeralSession.url);

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

Returns Examples

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