Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.corti.ai/llms.txt

Use this file to discover all available pages before exploring further.

Use configureApp() for app-level configuration such as UI visibility, 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;
  };
  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,
  },
  appearance: {
    primaryColor: "#000000",
  },
  locale: {
    interfaceLanguage: "da-DK",
    dictationLanguage: "da",
    overrides: {
      "interview.document.syncDocument.label": "Sync Document",
    },
  },
  network: {
    websocketBaseUrl: "wss://proxy.example.com",
  },
});

​
Prerequisites

  • None

​
Input validation

  • debug, ui.interactionTitle, ui.aiChat, ui.documentFeedback, and ui.navigation: 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.