Skip to content

Modes

The Copilot supports four application modes. Each mode is optimized for a different use case and ships with sensible defaults for panel visibility and navigation.

Panel visibility defaults

Panelembedpreviewlink_previewwidget
showConversationsYesYesYesNo
showActivityNoYesNoNo

Override either default explicitly by passing showConversations or showActivity as a prop.

embed - production

Full-featured mode for production applications. Includes conversation history, worker switching, and complete navigation.

Use when: building customer-facing applications with full Copilot functionality.

  • Conversation sidebar enabled
  • Full header with navigation
  • Worker / agent switching enabled
  • Activity panel disabled (clean UX for end users)

preview - development and testing

Developer-focused mode with debugging capabilities. Shows activity traces and tool calls for inspecting worker behavior.

Use when: testing workers during development, debugging API responses, or viewing execution traces.

  • Conversation sidebar enabled
  • Activity / trace panel enabled
  • Worker / agent switching enabled
  • No header (minimal UI to focus on debugging)

URL-based mode for demos, presentations, and shared links.

Use when: sharing a worker via URL or creating demos.

  • Conversation sidebar enabled
  • Worker / agent switching enabled
  • No header
  • Activity panel disabled

widget - minimal embedding

Minimal mode for embedding in constrained spaces - modals, sidebars, or third-party integrations.

Use when: embedding in modals, sidebars, or any space-constrained UI.

  • Minimal header (title only, no navigation)
  • No conversation sidebar
  • No worker switching
  • No activity panel

Decision matrix

ScenarioRecommended mode
Customer-facing app with full featuresembed
Testing worker behavior during developmentpreview
Need to see execution traces and tool callspreview
Sharing a worker via URL linklink_preview
Demo with auto-starting voice calllink_preview
Embedding in a modal or sidebarwidget
Minimal UI with no navigationwidget
Third-party integration with space constraintswidget
Debugging API responses and tracespreview