Create an ephemeral Viewer session

EphemeralSessionCreateResponse Viewer.EphemeralSessions.Create(, )

POST/v1/viewer/ephemeral-sessions

Mints a 30-second tokenized landing URL for a userless, studyless 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

EphemeralSessionCreateParams parameters

required string retrievalID

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

minLength1

maxLength1024

EphemeralHangingProtocol hangingProtocol

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

IReadOnlyDictionary<string, JsonElement> options

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

class EphemeralSessionCreateResponse:

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

required string Url

Create an ephemeral Viewer session

EphemeralSessionCreateParams parameters = new() { RetrievalID = "order-12345" };

var ephemeralSession = await client.Viewer.EphemeralSessions.Create(parameters);

Console.WriteLine(ephemeralSession);

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

Returns Examples

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