API Reference

Overview of the Embedded API surface, method groups, error model, and common workflows.

This page gives you the structure of the Embedded API and links to the individual method reference pages.

Applies to all integration methods

The Embedded API is available through the Web Component API, Window API, and PostMessage API. The underlying capabilities and error model are shared, but the invocation shape differs by integration method.

Examples use the Web Component API shape

The linked method reference pages use the Web Component or React API shape for consistency. When you use the Window API or PostMessage, the same operation often keeps the same payload but changes how it is invoked.

How to use this reference

Use the method pages in the sidebar when you need payload details, validation rules, error cases, or return types for a specific method.

The API Reference is grouped into:

• Application methods for authentication, app-level configuration, navigation, account state, and template lookup
• Interaction methods for interaction setup, session defaults, contextual facts, and recording control
• Deprecated methods within those groups when you still need the legacy configuration flow during the deprecation period

If you need configuration behavior, scenarios, or migration help, use these pages alongside the method reference:

• Configuration Scenarios
• Config Migration Guide
• Scheduled Deprecations

Method groups

Application

• auth() - Authenticate the embedded user session
• configureApp() - Apply app-level UI, appearance, locale, and network configuration
• navigate() - Navigate to an internal Assistant route
• setCredentials() - Update the authenticated user’s credentials
• getStatus() - Read current application and interaction state
• getTemplates() - Retrieve available templates for the authenticated user
• configure() (Deprecated) - Legacy app configuration structure

Interaction

• createInteraction() - Create a new interaction session
• setInteractionOptions() - Apply interaction-level defaults and options
• addFacts() - Add contextual facts to the current interaction
• startRecording() - Start recording in the current session
• stopRecording() - Stop recording in the current session
• configureSession() (Deprecated) - Legacy session-level defaults

Error codes

All API actions may return errors with the following structure:

{
  message: string,
  code: "UNAUTHORIZED" | "NOT_READY" | "NOT_FOUND" | "INVALID_PAYLOAD" | "INTERNAL_ERROR",
  details?: unknown,
}

Code	Description	Common causes
UNAUTHORIZED	User is not authenticated or the session expired	auth() was not called, or tokens are no longer valid
NOT_READY	A required precondition is missing	No active interaction, not in recording context, or a required view is not open
NOT_FOUND	A requested resource does not exist	Invalid interaction ID, user not found, or template not found
INVALID_PAYLOAD	Request payload validation failed	Missing required fields, invalid formats, unsupported values
INTERNAL_ERROR	Unexpected client or server failure	Retry the request or contact support if the issue persists

Workflows

Workflow examples now live on API Reference Workflows.

Use that page when you want end-to-end examples that combine multiple methods into a realistic integration flow.

Configuration-specific reference

Configuration-specific lookup data such as supported interface languages, dictation language codes, and string override keys lives in the configuration documentation rather than in the method reference.

Use these pages when you need those details:

• Supported Values
• Configuration Scenarios
• Config Migration Guide

Related documentation

• Web Component API - Package API and integration overview
• Window API - Same-origin method invocation
• PostMessage API - Cross-frame method invocation
• Welcome - Overview of the embedded Assistant

Please contact us if you need help with a specific API method or integration pattern.