{
"version": "1.0.0",
"categories": [
{
"id": "dev-ex",
"name": "Dev Ex"
},
{
"id": "chat-ui",
"name": "Chat & UI"
},
{
"id": "platform",
"name": "Platform"
},
{
"id": "controlled-generative-ui",
"name": "Controlled Generative UI"
},
{
"id": "declarative-generative-ui",
"name": "Declarative Generative UI"
},
{
"id": "open-generative-ui",
"name": "Open-Ended Generative UI"
},
{
"id": "operational-generative-ui",
"name": "Operational Generative UI"
},
{
"id": "interactivity",
"name": "Interactivity"
},
{
"id": "agent-state",
"name": "Agent State"
},
{
"id": "multi-agent",
"name": "Multi-Agent"
},
{
"id": "byoc",
"name": "BYOC (Bring Your Own Components)"
}
],
"features": [
{
"id": "cli-start",
"name": "CLI Start Command",
"category": "dev-ex",
"description": "One-liner to scaffold a new CopilotKit app via the official CLI",
"kind": "docs-only",
"og_docs_url": "https://docs.copilotkit.ai/quickstart",
"shell_docs_path": "/quickstart"
},
{
"id": "beautiful-chat",
"name": "Beautiful Chat",
"category": "dev-ex",
"description": "Canonical polished starter chat (same as /examples/integrations/langgraph-python)",
"kind": "primary",
"og_docs_url": "https://docs.copilotkit.ai/agentic-chat-ui",
"shell_docs_path": "/agentic-chat-ui"
},
{
"id": "agentic-chat",
"name": "Pre-Built: CopilotChat",
"category": "chat-ui",
"description": "Pre-built component for full-screen/embedded chat",
"kind": "primary",
"og_docs_url": "https://docs.copilotkit.ai/agentic-chat-ui",
"shell_docs_path": "/agentic-chat-ui"
},
{
"id": "prebuilt-sidebar",
"name": "Pre-Built: Sidebar",
"category": "chat-ui",
"description": "Docked sidebar chat via ",
"og_docs_url": "https://docs.copilotkit.ai/prebuilt-components",
"shell_docs_path": "/prebuilt-components/sidebar"
},
{
"id": "prebuilt-popup",
"name": "Pre-Built: Popup",
"category": "chat-ui",
"description": "Floating popup chat via ",
"og_docs_url": "https://docs.copilotkit.ai/prebuilt-components",
"shell_docs_path": "/prebuilt-components/popup"
},
{
"id": "chat-slots",
"name": "Chat Customization: Slots",
"category": "chat-ui",
"description": "Customizing chat components via the slot system",
"og_docs_url": "https://docs.copilotkit.ai/custom-look-and-feel/slots",
"shell_docs_path": "/custom-look-and-feel/slots"
},
{
"id": "chat-customization-css",
"name": "Chat Customization: CSS",
"category": "chat-ui",
"description": "Customizing chat components via CSS",
"og_docs_url": "https://docs.copilotkit.ai/custom-look-and-feel",
"shell_docs_path": "/custom-look-and-feel/css"
},
{
"id": "headless-simple",
"name": "Headless UI: Simple",
"category": "chat-ui",
"description": "Simple headless UI getting started",
"og_docs_url": "https://docs.copilotkit.ai/headless",
"shell_docs_path": "/headless"
},
{
"id": "headless-complete",
"name": "Headless UI: Complete",
"category": "chat-ui",
"description": "Full headless UI with messages, tools, gen UI",
"og_docs_url": "https://docs.copilotkit.ai/headless",
"shell_docs_path": "/headless"
},
{
"id": "gen-ui-tool-based",
"name": "Generative UI: useComponent",
"category": "controlled-generative-ui",
"description": "Agent renders typed React components via the useComponent hook",
"og_docs_url": "https://docs.copilotkit.ai/generative-ui/your-components/display-only",
"shell_docs_path": "/generative-ui/your-components/display-only"
},
{
"id": "hitl-in-chat",
"name": "Human In the Loop: In-chat",
"category": "controlled-generative-ui",
"description": "Interactive approval/decision surface rendered inline in the chat. Uses the high-level `useHumanInTheLoop` hook \u2014 handles the interrupt lifecycle for you.",
"og_docs_url": "https://docs.copilotkit.ai/generative-ui/your-components/interactive",
"shell_docs_path": "/generative-ui/your-components/interactive"
},
{
"id": "gen-ui-interrupt",
"name": "Human in the Loop: Interrupts",
"category": "controlled-generative-ui",
"description": "Interactive component rendered inline in the chat via the lower-level `useInterrupt` primitive \u2014 direct control over the LangGraph interrupt lifecycle.",
"og_docs_url": "https://docs.copilotkit.ai/human-in-the-loop",
"shell_docs_path": "/human-in-the-loop/useInterrupt"
},
{
"id": "hitl-in-chat-booking",
"name": "In-Chat HITL (Booking)",
"category": "controlled-generative-ui",
"description": "Time-picker card rendered inline via useHumanInTheLoop for a booking flow",
"kind": "primary",
"og_docs_url": "https://docs.copilotkit.ai/generative-ui/your-components/interactive",
"shell_docs_path": "/generative-ui/your-components/interactive",
"deprecated": true
},
{
"id": "hitl",
"name": "In-Chat Human in the Loop (Original)",
"category": "controlled-generative-ui",
"description": "Original HITL demo kept for backwards compatibility",
"kind": "primary",
"og_docs_url": "https://docs.copilotkit.ai/generative-ui/your-components/interactive",
"shell_docs_path": "/generative-ui/your-components/interactive",
"deprecated": true
},
{
"id": "interrupt-headless",
"name": "Human in the Loop: Headless Interrupts",
"category": "controlled-generative-ui",
"description": "Resolve langgraph interrupts headlessly via agent.subscribe + copilotkit.runAgent \u2014 no chat, no useInterrupt render prop",
"kind": "testing",
"shell_docs_path": "/human-in-the-loop/headless",
"og_docs_url": "https://docs.copilotkit.ai/headless"
},
{
"id": "declarative-gen-ui",
"name": "Declarative UI: Dynamic A2UI",
"category": "declarative-generative-ui",
"description": "Canonical A2UI BYOC \u2014 custom catalog wired via a2ui.catalog",
"og_docs_url": "https://docs.copilotkit.ai/generative-ui/a2ui",
"shell_docs_path": "/generative-ui/a2ui/dynamic-schema"
},
{
"id": "a2ui-fixed-schema",
"name": "Declarative UI: Fixed A2UI",
"category": "declarative-generative-ui",
"description": "A2UI rendering against a known, fixed client-side schema",
"og_docs_url": "https://docs.copilotkit.ai/generative-ui/a2ui",
"shell_docs_path": "/generative-ui/a2ui/fixed-schema"
},
{
"id": "a2ui-recovery",
"name": "A2UI Error Recovery",
"category": "declarative-generative-ui",
"description": "Visible A2UI validate-retry recovery loop: an invalid render heals to a valid one, an always-invalid render shows a graceful recovery-exhausted fallback",
"og_docs_url": "https://docs.copilotkit.ai/generative-ui/a2ui",
"shell_docs_path": "/generative-ui/a2ui/dynamic-schema"
},
{
"id": "mcp-apps",
"name": "MCP Apps",
"category": "open-generative-ui",
"description": "MCP server integration with UI display",
"og_docs_url": "https://docs.copilotkit.ai/generative-ui/mcp-apps",
"shell_docs_path": "/generative-ui/mcp-apps"
},
{
"id": "open-gen-ui",
"name": "Open Generative UI: Default",
"category": "open-generative-ui",
"description": "Agent-generated UI from arbitrary component libraries",
"og_docs_url": "https://docs.copilotkit.ai/generative-ui/open-generative-ui",
"shell_docs_path": "/generative-ui/open-generative-ui"
},
{
"id": "open-gen-ui-advanced",
"name": "Open Generative UI: Custom",
"category": "open-generative-ui",
"description": "Agent-authored UI that can invoke frontend sandbox functions from inside the iframe",
"og_docs_url": "https://docs.copilotkit.ai/generative-ui/open-generative-ui",
"shell_docs_path": "/generative-ui/open-generative-ui"
},
{
"id": "tool-rendering-default-catchall",
"name": "Generative UI: Tool Rendering (Default)",
"category": "operational-generative-ui",
"description": "Out-of-the-box rendering: backend tools surfaced via CopilotKit's built-in default catch-all renderer; no frontend customization",
"kind": "primary",
"og_docs_url": "https://docs.copilotkit.ai/generative-ui/tool-rendering",
"shell_docs_path": "/generative-ui/tool-rendering"
},
{
"id": "tool-rendering-custom-catchall",
"name": "Generative UI: Tool Rendering (Custom default)",
"category": "operational-generative-ui",
"description": "Single branded wildcard renderer that paints every tool call \u2014 one card handles them all",
"kind": "primary",
"og_docs_url": "https://docs.copilotkit.ai/generative-ui/tool-rendering",
"shell_docs_path": "/generative-ui/tool-rendering"
},
{
"id": "tool-rendering",
"name": "Generative UI: Tool Rendering (Specific)",
"category": "operational-generative-ui",
"description": "Custom per-tool renderers for the tools you care about, plus a wildcard catch-all for the rest",
"og_docs_url": "https://docs.copilotkit.ai/generative-ui/tool-rendering",
"shell_docs_path": "/generative-ui/tool-rendering"
},
{
"id": "tool-rendering-reasoning-chain",
"name": "Generative UI: Rendering multiple tools",
"category": "operational-generative-ui",
"description": "Sequential tool calls with reasoning tokens rendered side-by-side",
"kind": "testing",
"og_docs_url": "https://docs.copilotkit.ai/generative-ui/tool-rendering",
"shell_docs_path": "/generative-ui/tool-rendering"
},
{
"id": "agentic-chat-reasoning",
"name": "Reasoning",
"category": "operational-generative-ui",
"description": "Visible reasoning/thinking chain alongside the final answer",
"og_docs_url": "https://docs.copilotkit.ai/custom-look-and-feel/reasoning-messages",
"shell_docs_path": "/custom-look-and-feel/reasoning-messages",
"deprecated": true
},
{
"id": "reasoning-default-render",
"name": "Reasoning (Default Render)",
"category": "operational-generative-ui",
"description": "Built-in CopilotChatReasoningMessage renders without a custom slot",
"kind": "testing",
"shell_docs_path": "/custom-look-and-feel/reasoning-messages",
"og_docs_url": "https://docs.copilotkit.ai/custom-look-and-feel/reasoning-messages",
"deprecated": true
},
{
"id": "reasoning-default",
"name": "Reasoning: Default",
"category": "operational-generative-ui",
"description": "Built-in CopilotChatReasoningMessage rendering with no slot override",
"shell_docs_path": "/custom-look-and-feel/reasoning-messages",
"og_docs_url": "https://docs.copilotkit.ai/custom-look-and-feel/reasoning-messages"
},
{
"id": "reasoning-custom",
"name": "Reasoning: Custom",
"category": "operational-generative-ui",
"description": "Custom reasoning slot override via messageView.reasoningMessage",
"shell_docs_path": "/custom-look-and-feel/reasoning-messages",
"og_docs_url": "https://docs.copilotkit.ai/custom-look-and-feel/reasoning-messages"
},
{
"id": "gen-ui-agent",
"name": "Generative UI: Agent State",
"category": "operational-generative-ui",
"description": "Agent-state-driven inline UI: the agent emits a live `steps` plan via copilotkit_emit_state and the frontend renders it with useCoAgentStateRender (v1 hook)",
"og_docs_url": "https://docs.copilotkit.ai/generative-ui/state-rendering",
"shell_docs_path": "/generative-ui/state-rendering"
},
{
"id": "frontend-tools",
"name": "Frontend Tools: In-app Actions",
"category": "interactivity",
"description": "Frontend tool execution triggered by the agent",
"og_docs_url": "https://docs.copilotkit.ai/frontend-tools",
"shell_docs_path": "/frontend-tools"
},
{
"id": "frontend-tools-async",
"name": "Frontend Tools: Async",
"category": "interactivity",
"description": "useFrontendTool with an async handler \u2014 agent awaits a client-side async operation (e.g. DB query) and uses the returned result",
"og_docs_url": "https://docs.copilotkit.ai/frontend-tools",
"shell_docs_path": "/frontend-tools"
},
{
"id": "threadid-frontend-tool-roundtrip",
"name": "ThreadID: Frontend Tool Round-Trip",
"category": "interactivity",
"description": "Regression demo for ENT-658 — verifies that an explicit threadId survives a useFrontendTool round-trip (agent invokes a frontend tool, awaits the async handler, and the same threadId is preserved across the resume).",
"kind": "testing",
"shell_docs_path": "/frontend-tools",
"og_docs_url": "https://docs.copilotkit.ai/frontend-tools"
},
{
"id": "hitl-in-app",
"name": "Human in the Loop: In-app",
"category": "interactivity",
"description": "Agent calls useFrontendTool with an async handler; the approval UI pops up as an app-level modal OUTSIDE the chat, and a completion callback resolves the pending tool Promise with the user's decision",
"og_docs_url": "https://docs.copilotkit.ai/human-in-the-loop",
"shell_docs_path": "/human-in-the-loop"
},
{
"id": "shared-state-read-write",
"name": "Shared State: Read + Write",
"category": "agent-state",
"description": "Bidirectional agent state \u2014 UI writes preferences, agent writes notes back",
"og_docs_url": "https://docs.copilotkit.ai/shared-state",
"shell_docs_path": "/shared-state"
},
{
"id": "shared-state-read",
"name": "Shared State: Read-only",
"category": "agent-state",
"description": "Frontend recipe form publishes shared state via agent.setState; agent reads but does not mutate the recipe (neutral default agent, no backend tool)",
"kind": "testing",
"og_docs_url": "https://docs.copilotkit.ai/shared-state",
"shell_docs_path": "/shared-state"
},
{
"id": "shared-state-streaming",
"name": "Shared State: Streaming",
"category": "agent-state",
"description": "Per-token state delta streaming from agent to UI",
"og_docs_url": "https://docs.copilotkit.ai/shared-state",
"shell_docs_path": "/shared-state/streaming"
},
{
"id": "readonly-state-agent-context",
"name": "Shared State: Frontend Context",
"category": "agent-state",
"description": "Frontend provides read-only context to the agent via useAgentContext",
"og_docs_url": "https://docs.copilotkit.ai/shared-state",
"shell_docs_path": "/shared-state/agent-readonly"
},
{
"id": "subagents",
"name": "Sub-Agents",
"category": "multi-agent",
"description": "Multiple agents with visible task delegation",
"shell_docs_path": "/multi-agent/subagents",
"og_docs_url": "https://docs.copilotkit.ai/coagents/multi-agent-flows"
},
{
"id": "auth",
"name": "Authentication",
"category": "platform",
"description": "Framework-native authentication",
"shell_docs_path": "/auth"
},
{
"id": "agent-config",
"name": "Agent Config Object",
"category": "platform",
"description": "Forwarded props / config objects",
"shell_docs_path": "/agent-config"
},
{
"id": "voice",
"name": "Voice",
"category": "platform",
"description": "Real-time voice interaction",
"shell_docs_path": "/voice"
},
{
"id": "multimodal",
"name": "Attachments",
"category": "platform",
"description": "File upload and agent processing",
"shell_docs_path": "/multimodal-attachments",
"og_docs_url": "https://docs.copilotkit.ai/multimodal-attachments"
},
{
"id": "byoc-hashbrown",
"name": "Declarative UI: Hashbrown",
"category": "byoc",
"description": "Hashbrown-style generative UI (legacy slug — superseded by `declarative-hashbrown`; kept so the other 17 integrations whose manifests still declare this ID don't drop out of the catalog before their cross-codebase rename lands)",
"deprecated": true
},
{
"id": "byoc-json-render",
"name": "Declarative UI: json-render",
"category": "byoc",
"description": "Streaming structured-output generative UI via @json-render/react (legacy slug — superseded by `declarative-json-render`; kept for cross-integration parity until the rename completes elsewhere)",
"deprecated": true
},
{
"id": "declarative-hashbrown",
"name": "Declarative UI: Hashbrown",
"category": "byoc",
"description": "Hashbrown-style generative UI"
},
{
"id": "declarative-json-render",
"name": "Declarative UI: json-render",
"category": "byoc",
"description": "Streaming structured-output generative UI via @json-render/react"
}
]
}