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 configureSession() only if you still depend on the legacy session-configuration structure.
configureSession() is deprecated in favor of setInteractionOptions(). It continues to work during the deprecation period. If your integration depends on defaultOutputLanguage, keep using its legacy-compatible behavior during this period. See the Migration Guide and Scheduled Deprecations.

Usage

await api.configureSession({
  defaultLanguage: "en",
  defaultOutputLanguage: "en",
  defaultTemplateKey: "corti-soap",
  defaultMode: "virtual",
});
await api.configureSession({
  defaultTemplateKey: "corti-soap",
  defaultOutputLanguage: "en",
});

Prerequisites

  • User must be authenticated.

Input validation

  • defaultLanguage: Must be a valid language code.
  • defaultOutputLanguage: Must be a valid language code.
  • defaultTemplateKey: Must be a language-agnostic template identifier.
  • defaultMode: Must be either "virtual" or "in-person".
  • If either defaultTemplateKey or defaultOutputLanguage is provided, both must be provided together.

Possible errors

  • UNAUTHORIZED: User not authenticated.
  • INVALID_PAYLOAD: Invalid payload, including when only one of defaultTemplateKey or defaultOutputLanguage is provided.
  • NOT_FOUND: No template matches defaultTemplateKey plus defaultOutputLanguage.
  • INTERNAL_ERROR: Failed to update session settings.

Returns

void