configureApp()

Use configureApp() for app-level configuration such as UI visibility, companion app access, patient consent, appearance, locale, and network settings.

debug enables a debug panel intended for development only. Do not enable it in staging or production.

Applies to Web Component, Window API, and PostMessage. Examples on this page use the Web Component API shape.

configureApp() is patchable and may be called multiple times.

Use Configuration Scenarios for practical examples and Supported Values for supported languages and override keys.

Payload shape

type ConfigureAppPayload = {
  debug?: boolean;
  ui?: {
    interactionTitle?: boolean;
    aiChat?: boolean;
    documentFeedback?: boolean;
    navigation?: boolean;
  };
  companionApp?: {
    enabled: boolean;
  };
  consent?: {
    enabled: boolean;
  };
  appearance?: {
    primaryColor?: string | null;
  };
  locale?: {
    interfaceLanguage?: string;
    dictationLanguage?: string | null;
    overrides?: Record<string, string>;
  };
  network?: {
    websocketBaseUrl?: string | null;
  };
};

Usage

await api.configureApp({
  debug: false,
  ui: {
    interactionTitle: true,
    aiChat: true,
    documentFeedback: true,
    navigation: false,
  },
  companionApp: {
    enabled: true,
  },
  consent: {
    enabled: false,
  },
  appearance: {
    primaryColor: "#000000",
  },
  locale: {
    interfaceLanguage: "da-DK",
    dictationLanguage: "da",
    overrides: {
      "interview.document.syncDocument.label": "Sync Document",
    },
  },
  network: {
    websocketBaseUrl: "wss://proxy.example.com",
  },
});

Set consent.enabled to true to require users to confirm patient consent before an in-person recording starts or resumes. Consent is stored per interaction, so users confirm it once per interaction. Consent is disabled by default. If the user declines, recording does not start and startRecording() rejects with FORBIDDEN. See I want users to confirm patient consent before recording for an example.

TypeScript integrations using the Web Component or React need @corti/embedded-web@2.1.0 or later for the consent types in configureApp().

Prerequisites

None

Input validation

debug, ui.interactionTitle, ui.aiChat, ui.documentFeedback, ui.navigation, companionApp.enabled, and consent.enabled: Must be boolean values when provided.
appearance.primaryColor: Must be a valid CSS color string or null when provided.
locale.interfaceLanguage: Must be a supported interface language when provided.
locale.dictationLanguage: Must be a supported dictation language or null when provided.
locale.overrides: Keys must match known override strings.
network.websocketBaseUrl: Must be a valid WebSocket URL or null when provided. This is mainly for proxy deployments. See the Proxy guide.

Possible errors

INVALID_PAYLOAD: Invalid color, URL, language code, or non-boolean UI value.
INTERNAL_ERROR: Failed to apply configuration.

Returns

This method is documented as a configuration action and does not expose a response payload in the current public reference.

Clinical Text Generation

Medical Coding

Clinical Assistant

Payload shape

Usage

Prerequisites

Input validation

Possible errors

Returns

​Payload shape

​Usage

​Patient consent

​Prerequisites

​Input validation

​Possible errors

​Returns

​Related reference

Payload shape

Usage

Patient consent

Prerequisites

Input validation

Possible errors

Returns

Related reference