Skip to main content
Use navigate() to move the embedded Assistant to a specific internal route.
Applies to Web Component, Window API, and PostMessage. Examples on this page use the Web Component API shape.

​
Usage

For consistency across transports, prefer object payload form.Web Component / React compatibility:
  • @corti/embedded-web earlier than 0.3.0: only api.navigate("/session/interaction-123") is accepted.
  • @corti/embedded-web@0.3.0 and later: both api.navigate("/session/interaction-123") and api.navigate({ path: "/session/interaction-123" }) are accepted.

​
Prerequisites

  • None

​
Input validation

  • Window API / PostMessage: payload must be an object with path.
  • Web Component / React on @corti/embedded-web@0.3.0 and later: payload can be an object with path (recommended) or a path string.
  • Web Component / React on versions earlier than 0.3.0: payload must be a path string.
  • path: Required.
  • path: Must be a string that starts with /.
  • path: Cannot be a full URL.
  • path: Must stay within the embedded application.

​
Possible errors

  • INVALID_PAYLOAD:
    • Path does not start with /.
    • Path is a full URL.
  • INTERNAL_ERROR: Navigation failed.

​
Returns

void

​
Valid path patterns

  • / - start a new session
  • /session/<id> - open an existing session
  • /templates - browse and create templates
  • /settings/preferences - edit defaults like languages and default session settings
  • /settings/input - edit dictation input settings
  • /settings/account - edit general account settings
  • /settings/archive - view items in and restore from archive