CopilotSidebar

# Agent implementation for Prebuilt Sidebar# The LlamaIndex agent is defined in src/agents/agent.py# The prebuilt_sidebar agent name is registered in src/app/api/copilotkit/route.ts.

What is this?#

<CopilotSidebar> is a prebuilt chat surface that docks to the side of your app. It wraps your main content so the chat can slide out on demand, making it a good fit for in-app copilots that need to stay accessible without taking over the entire viewport.

When should I use this?#

Use the sidebar when you want:

• A persistent, collapsible chat attached to your app shell
• Chat to live alongside your main content rather than on top of it
• A launcher the user can toggle without losing their place

For a floating bubble that overlays content, see CopilotPopup. For a fully embedded chat pane, use <CopilotChat> directly.

Basic setup#

Wrap your app in <CopilotKit> once (it wires the runtime, session, and agent registry) and drop <CopilotSidebar> alongside your main content. The sidebar renders as a sibling so it can slide out without reflowing your page:

    <CopilotKit runtimeUrl="/api/copilotkit" agent="prebuilt_sidebar">      <MainContent />      <CopilotSidebar agentId="prebuilt_sidebar" defaultOpen={true} />      <Suggestions />    </CopilotKit>

Configuring the sidebar#

<CopilotSidebar> accepts the same props as <CopilotChat> plus a few of its own. The example below opens the sidebar by default and targets a named agent:

      <CopilotSidebar agentId="prebuilt_sidebar" defaultOpen={true} />

Common sidebar-specific props:

Styling#

CopilotSidebar participates in the slot system, so every piece of its UI is customizable, from Tailwind classes on the message view to a full component swap for the header or toggle button. See custom look and feel for the full slot reference.