getStatus()

​

Usage

const status = await api.getStatus();

​

Prerequisites

• None

​

Input validation

• None

​

Possible errors

• This action does not typically throw structured error codes.
• In rare cases, partial data may be returned if specific state queries fail.

​

Returns

{
  applicationVersion: string,
  auth: {
    isAuthenticated: boolean,
    user: {
      id: string,
      email: string
    } | null
  },
  currentUrl: string,
  isMedicalDevice: boolean,
  medicalDevice?: {
    buildDate: string,
    deviceIdentifier: string,
    udi: string
  },
  interaction: {
    id: string,
    title: string,
    state: "planned" | "ongoing" | "paused" | "disconnected" | "ending" | "parsing" | "ended",
    startedAt: string,
    endedAt: string | null,
    endsAt: string | null,
    transcripts: Array<unknown>,
    documents: Array<unknown>,
    facts: Array<unknown>,
    websocketUrl: string
  } | null
}

​

Notes

• This method is useful for debugging and for checking whether prerequisites are already satisfied.
• applicationVersion is the application release version.
• isMedicalDevice indicates whether the current build is a regulated medical device. When true, the medicalDevice object is included with the device identifier, build date, and composed UDI. When false, medicalDevice is omitted.
• interaction may be null if no interaction is active or if interaction lookup fails.

​

Related reference

• API Reference Overview
• auth()
• createInteraction()