fix: fix improper CopilotKit casing "Copilotkit" → "CopilotKit"

This commit is contained in:
Brandon McConnell
2025-11-06 11:46:51 -05:00
parent e49c200ad9
commit f27f9748c4
44 changed files with 79 additions and 79 deletions
+2 -2
View File
@@ -1,6 +1,6 @@
# Security Policy
At **Copilotkit**, we are continuously working to improve not only the product but also the open-source repository. To achieve this, we encourage you to take some time to responsibly disclose any issues you may encounter.
At **CopilotKit**, we are continuously working to improve not only the product but also the open-source repository. To achieve this, we encourage you to take some time to responsibly disclose any issues you may encounter.
## Reporting a Vulnerability
@@ -26,7 +26,7 @@ We hope this product meets your expectations. However, if you notice anything th
- **Resolution**: We aim to release a fix or mitigation within 30 days of confirming the vulnerability.
### Note
**If you do not receive an acknowledgment of your email within 48 hours, and you havent heard from our security team after 5 days, please directly message someone from the Copilotkit team in our [Discord community](https://discord.gg/6dffbvGU3D).**
**If you do not receive an acknowledgment of your email within 48 hours, and you havent heard from our security team after 5 days, please directly message someone from the CopilotKit team in our [Discord community](https://discord.gg/6dffbvGU3D).**
## Security Best Practices
+1 -1
View File
@@ -18,7 +18,7 @@ Please show your support and give a ⭐ to the [CopilotKit repository](https://g
1. **Project Setup and Guidelines**: Check out the [CONTRIBUTING.md](./CONTRIBUTING.md) for detailed setup instructions and contribution guidelines.
2. **Choose a Topic**: Browse our [Issues section](https://github.com/CopilotKit/CopilotKit/issues) tagged with `hacktoberfest`. CopilotKit allows multi-assignment!
3. **Submit Your Demo**: Build and submit your project following the steps in the `CONTRIBUTING.md`.
4. **Share Your Project**: Post your project on Twitter/X tagging `@Copilotkit` and adding the hashtag `#CopilotKitHacktoberfest` at the bottom of the post. The projects with the **most likes** will be crowned winners!
4. **Share Your Project**: Post your project on Twitter/X tagging `@CopilotKit` and adding the hashtag `#CopilotKitHacktoberfest` at the bottom of the post. The projects with the **most likes** will be crowned winners!
---
@@ -1,5 +1,5 @@
# 1. Copilotkit-weather-Bot
# 1. CopilotKit-weather-Bot
This Next.js application is a weather forecasting tool that utilizes CopilotKit for
AI-powered interactions and Shadcn-UI for styling. It allows users to input a location and receive
real-time weather information, including temperature, description, humidity, and wind speed.
@@ -28,13 +28,13 @@ List the technologies and frameworks you used (e.g., CopilotKit, Next.js)
## 4. GitHub Project Link
### GitHub Repo Link:
[JanumalaAkhilendra/Copilotkit-weather-bot](https://github.com/JanumalaAkhilendra/Copilotkit-weather-bot)
[JanumalaAkhilendra/CopilotKit-weather-bot](https://github.com/JanumalaAkhilendra/CopilotKit-weather-bot)
### 5 bonus points
- If your app is live, include the link here:
- [Live app](https://copilotkit-weather-bot.vercel.app/)
- A youtube video demo of Copilotkit-weather-bot is available [here](https://youtu.be/F2wiIcNrwOg)
- A youtube video demo of CopilotKit-weather-bot is available [here](https://youtu.be/F2wiIcNrwOg)
## 6. Screenshot
+1 -1
View File
@@ -20,7 +20,7 @@ List the technologies and frameworks you used (e.g., CopilotKit, Next.js)
## 4. GitHub Project Link
### GitHub Repo Link:
[https://github.com/prathamesh424/EventCounter--Copilotkit](https://github.com/prathamesh424/EventCounter--Copilotkit)
[https://github.com/prathamesh424/EventCounter--CopilotKit](https://github.com/prathamesh424/EventCounter--CopilotKit)
### 5 bonus points
+1 -1
View File
@@ -23,7 +23,7 @@ Event Planner ( Hacktoberfest Demo )
## Content
- [Dev.to - Copilotkit: Your AI Wingman for Coding Adventures](https://dev.to/chiragagg5k/copilotkit-your-ai-wingman-for-coding-adventures-28gl)
- [Dev.to - CopilotKit: Your AI Wingman for Coding Adventures](https://dev.to/chiragagg5k/copilotkit-your-ai-wingman-for-coding-adventures-28gl)
- [Quira - Quest 20 Submission](https://quira.sh/repo/ChiragAgg5k-cal-buddy-863122206)
- [Twitter - Sharing Progress](https://x.com/ChiragAgg5k/status/1839259454216323135)
@@ -5,7 +5,7 @@ In this project, I developed a Task Manager using React for the frontend, Tailwi
### Method 1 - Using Form
- User can add Task using form with its detail description, date & time and also needs to add priority of task.
- User also show task completed as well as delete the task.
### Method 2 - Using Copilotkit
### Method 2 - Using CopilotKit
- User need to write task name,task details also update and delete the task.
## 2. Name of Issue/Topic
+1 -1
View File
@@ -1,6 +1,6 @@
## 🚀 **Movie-BOT**
[Movie-Copilotkit-Bot](https://moviebot-sigma.vercel.app/) - An AI powered Movie Bot app that suggests you movies based on the genre , mood and your previous watch history.
[Movie-CopilotKit-Bot](https://moviebot-sigma.vercel.app/) - An AI powered Movie Bot app that suggests you movies based on the genre , mood and your previous watch history.
### 📝 **Name of Issue/Topic**
+1 -1
View File
@@ -3,7 +3,7 @@ In this project, I developed a TO-DO List with Prioritization using React for th
### Method 1 - Using Form
- User can add Task using form with its detail description, date & time and also needs to add priority of task.
- User also show task completed as well as delete the task.
### Method 2 - Using Copilotkit
### Method 2 - Using CopilotKit
- User need to write task name,task details, due date and time as well as priority of task.
## 2. Name of Issue/Topic
@@ -36,7 +36,7 @@ from using our built-in UI components to fully customizing the UI with headless
<Card
className="border border-gray-300 hover:border-gray-400 transition-colors"
title={<div className="mb-3"><SettingsIcon className="inline mr-2" />Markdown Rendering</div>}
description="Modify Copilotkit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps."
description="Modify CopilotKit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps."
href="./custom-look-and-feel/markdown-rendering"
/>
</Cards>
@@ -36,7 +36,7 @@ from using our built-in UI components to fully customizing the UI with headless
<Card
className="border border-gray-300 hover:border-gray-400 transition-colors"
title={<div className="mb-3"><SettingsIcon className="inline mr-2" />Markdown Rendering</div>}
description="Modify Copilotkit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps."
description="Modify CopilotKit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps."
href="./custom-look-and-feel/markdown-rendering"
/>
</Cards>
+1 -1
View File
@@ -1,6 +1,6 @@
---
title: AG2
description: An agentic framework for building LLM applications that can be used with Copilotkit.
description: An agentic framework for building LLM applications that can be used with CopilotKit.
icon: custom/ag2
---
@@ -36,7 +36,7 @@ from using our built-in UI components to fully customizing the UI with headless
<Card
className="border border-gray-300 hover:border-gray-400 transition-colors"
title={<div className="mb-3"><SettingsIcon className="inline mr-2" />Markdown Rendering</div>}
description="Modify Copilotkit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps."
description="Modify CopilotKit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps."
href="./custom-look-and-feel/markdown-rendering"
/>
</Cards>
@@ -105,7 +105,7 @@ Before we dive into what agentic copilots are, help us help you by telling us yo
<TailoredContentOption
id="intermediate"
title="I'm already using Agno"
description="Help me understand what agentic copilots are, what Copilotkit does to integrate with Agno, and how to get started."
description="Help me understand what agentic copilots are, what CopilotKit does to integrate with Agno, and how to get started."
icon={<SiLangchain />}
>
@@ -3,7 +3,7 @@ title: Streaming and Tool Calls
description: CoAgents support streaming your messages and tool calls to the frontend.
---
If you'd like to stream messages from your Agno agents you can utilize our Copilotkit SDK which provides a collection
If you'd like to stream messages from your Agno agents you can utilize our CopilotKit SDK which provides a collection
of functions and utilities for interacting with the agent's state or behavior. This allows you to choose how messages and
tool calls are emitted and streamed to the frontend.
@@ -1,6 +1,6 @@
---
title: Agno
description: An agentic framework for building LLM applications that can be used with Copilotkit.
description: An agentic framework for building LLM applications that can be used with CopilotKit.
icon: custom/agno
---
@@ -12,7 +12,7 @@ icon: custom/agno
/>
</Frame>
Agno is an agentic framework for building LLM applications that can be used with Copilotkit. Agno Agents allow developers
Agno is an agentic framework for building LLM applications that can be used with CopilotKit. Agno Agents allow developers
to combine and coordinate coding tasks efficiently, providing a robust framework for building sophisticated AI automations.
## CoAgents and Agno
@@ -26,7 +26,7 @@ Let's break down some key terms and understand how they relate to and are implem
- ** manage state**: CoAgents have bi-directional state sharing with the agent and UI. This allows for the agent to remember
information from previous messages and the UI to update the agent with new information. Read more about how state sharing works
[here](/agno/shared-state).
- **Multi-actor**: CoAgents allow for multiple agents to interact with each other. Copilotkit acts as the "ground-truth"
- **Multi-actor**: CoAgents allow for multiple agents to interact with each other. CopilotKit acts as the "ground-truth"
when transitioning between agents. Read more about how multi-actor workflows work [here](/agno/multi-agent-flows)
and how messages are managed [here](/agno/concepts/message-management).
- **LLMs**: CoAgents use large language models to generate responses. This is useful for building applications that need to
@@ -36,7 +36,7 @@ from using our built-in UI components to fully customizing the UI with headless
<Card
className="border border-gray-300 hover:border-gray-400 transition-colors"
title={<div className="mb-3"><SettingsIcon className="inline mr-2" />Markdown Rendering</div>}
description="Modify Copilotkit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps."
description="Modify CopilotKit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps."
href="./custom-look-and-feel/markdown-rendering"
/>
</Cards>
@@ -105,7 +105,7 @@ Before we dive into what agentic copilots are, help us help you by telling us yo
<TailoredContentOption
id="intermediate"
title="I'm already using CrewAI"
description="Help me understand what agentic copilots are, what Copilotkit does to integrate with CrewAI, and how to get started."
description="Help me understand what agentic copilots are, what CopilotKit does to integrate with CrewAI, and how to get started."
icon={<SiLangchain />}
>
@@ -3,7 +3,7 @@ title: Streaming and Tool Calls
description: CoAgents support streaming your messages and tool calls to the frontend.
---
If you'd like to stream messages from your CrewAI agents you can utilize our Copilotkit SDK which provides a collection
If you'd like to stream messages from your CrewAI agents you can utilize our CopilotKit SDK which provides a collection
of functions and utilities for interacting with the agent's state or behavior. This allows you to choose how messages and
tool calls are emitted and streamed to the frontend.
@@ -1,6 +1,6 @@
---
title: CrewAI
description: An agentic framework for building LLM applications that can be used with Copilotkit.
description: An agentic framework for building LLM applications that can be used with CopilotKit.
icon: custom/crewai
---
@@ -12,7 +12,7 @@ icon: custom/crewai
/>
</Frame>
CrewAI is an agentic framework for building LLM applications that can be used with Copilotkit. CrewAi Flows allow developers
CrewAI is an agentic framework for building LLM applications that can be used with CopilotKit. CrewAi Flows allow developers
to combine and coordinate coding tasks and Crews efficiently, providing a robust framework for building sophisticated AI automations.
## CoAgents and CrewAI
@@ -26,7 +26,7 @@ Let's break down some key terms and understand how they relate to and are implem
- **Manage state**: CoAgents have bi-directional state sharing with the agent and UI. This allows for the agent to remember
information from previous messages and the UI to update the agent with new information. Read more about how state sharing works
[here](/crewai-crews/shared-state).
- **Multi-actor**: CoAgents allow for multiple agents to interact with each other. Copilotkit acts as the "ground-truth"
- **Multi-actor**: CoAgents allow for multiple agents to interact with each other. CopilotKit acts as the "ground-truth"
when transitioning between agents. Read more about how multi-actor workflows work [here](/crewai-crews/multi-agent-flows)
and how messages are managed [here](/crewai-crews/concepts/message-management).
- **LLMs**: CoAgents use large language models to generate responses. This is useful for building applications that need to
@@ -36,7 +36,7 @@ from using our built-in UI components to fully customizing the UI with headless
<Card
className="border border-gray-300 hover:border-gray-400 transition-colors"
title={<div className="mb-3"><SettingsIcon className="inline mr-2" />Markdown Rendering</div>}
description="Modify Copilotkit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps."
description="Modify CopilotKit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps."
href="./custom-look-and-feel/markdown-rendering"
/>
</Cards>
@@ -105,7 +105,7 @@ Before we dive into what agentic copilots are, help us help you by telling us yo
<TailoredContentOption
id="intermediate"
title="I'm already using CrewAI"
description="Help me understand what agentic copilots are, what Copilotkit does to integrate with CrewAI, and how to get started."
description="Help me understand what agentic copilots are, what CopilotKit does to integrate with CrewAI, and how to get started."
icon={<SiLangchain />}
>
@@ -3,7 +3,7 @@ title: Streaming and Tool Calls
description: CoAgents support streaming your messages and tool calls to the frontend.
---
If you'd like to stream messages from your CrewAI agents you can utilize our Copilotkit SDK which provides a collection
If you'd like to stream messages from your CrewAI agents you can utilize our CopilotKit SDK which provides a collection
of functions and utilities for interacting with the agent's state or behavior. This allows you to choose how messages and
tool calls are emitted and streamed to the frontend.
@@ -1,6 +1,6 @@
---
title: CrewAI
description: An agentic framework for building LLM applications that can be used with Copilotkit.
description: An agentic framework for building LLM applications that can be used with CopilotKit.
icon: custom/crewai
---
@@ -12,7 +12,7 @@ icon: custom/crewai
/>
</Frame>
CrewAI is an agentic framework for building LLM applications that can be used with Copilotkit. CrewAi Flows allow developers
CrewAI is an agentic framework for building LLM applications that can be used with CopilotKit. CrewAi Flows allow developers
to combine and coordinate coding tasks and Crews efficiently, providing a robust framework for building sophisticated AI automations.
## CoAgents and CrewAI
@@ -26,7 +26,7 @@ Let's break down some key terms and understand how they relate to and are implem
- ** manage state**: CoAgents have bi-directional state sharing with the agent and UI. This allows for the agent to remember
information from previous messages and the UI to update the agent with new information. Read more about how state sharing works
[here](/crewai-flows/shared-state).
- **Multi-actor**: CoAgents allow for multiple agents to interact with each other. Copilotkit acts as the "ground-truth"
- **Multi-actor**: CoAgents allow for multiple agents to interact with each other. CopilotKit acts as the "ground-truth"
when transitioning between agents. Read more about how multi-actor workflows work [here](/crewai-flows/multi-agent-flows)
and how messages are managed [here](/crewai-flows/concepts/message-management).
- **LLMs**: CoAgents use large language models to generate responses. This is useful for building applications that need to
@@ -36,7 +36,7 @@ from using our built-in UI components to fully customizing the UI with headless
<Card
className="border border-gray-300 hover:border-gray-400 transition-colors"
title={<div className="mb-3"><SettingsIcon className="inline mr-2" />Markdown Rendering</div>}
description="Modify Copilotkit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps."
description="Modify CopilotKit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps."
href="./custom-look-and-feel/markdown-rendering"
/>
</Cards>
@@ -11,7 +11,7 @@ import {
TailoredContentOption,
} from "@/components/react/tailored-content.tsx";
import CopilotCloudConfigureRemoteEndpointLangGraphSnippet from "@/snippets/copilot-cloud-configure-remote-endpoint-langgraph.mdx";
import CopilotCloudConfigureCopilotkitProviderSnippet from "@/snippets/copilot-cloud-configure-copilotkit-provider.mdx";
import CopilotCloudConfigureCopilotKitProviderSnippet from "@/snippets/copilot-cloud-configure-copilotkit-provider.mdx";
import LangGraphPlatformDeploymentTabs from "@/snippets/langgraph-platform-deployment-tabs.mdx";
import { FaCloud, FaServer } from "react-icons/fa";
@@ -49,7 +49,7 @@ import { FaCloud, FaServer } from "react-icons/fa";
<Accordions className="my-4">
<Accordion title="Haven't setup Copilot Cloud yet? Click here!" >
Copilot Cloud hooks into your CopilotKit provider, so you'll need to set it up first if you haven't already.
<CopilotCloudConfigureCopilotkitProviderSnippet components={props.components} />
<CopilotCloudConfigureCopilotKitProviderSnippet components={props.components} />
</Accordion>
</Accordions>
<CopilotCloudConfigureRemoteEndpointLangGraphSnippet components={props.components} />
@@ -5,7 +5,7 @@ icon: "custom/python"
---
import FindCopilotRuntimeSnippet from "@/snippets/find-your-copilot-runtime.mdx";
import CopilotCloudConfigureRemoteEndpointSnippet from "@/snippets/copilot-cloud-configure-remote-endpoint.mdx";
import CopilotCloudConfigureCopilotkitProviderSnippet from "@/snippets/copilot-cloud-configure-copilotkit-provider.mdx";
import CopilotCloudConfigureCopilotKitProviderSnippet from "@/snippets/copilot-cloud-configure-copilotkit-provider.mdx";
import { TailoredContent, TailoredContentOption } from "@/components/react/tailored-content";
import { Accordions, Accordion } from "fumadocs-ui/components/accordion";
import { FaCloud, FaServer } from "react-icons/fa";
@@ -36,7 +36,7 @@ from using our built-in UI components to fully customizing the UI with headless
<Card
className="border border-gray-300 hover:border-gray-400 transition-colors"
title={<div className="mb-3"><SettingsIcon className="inline mr-2" />Markdown Rendering</div>}
description="Modify Copilotkit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps."
description="Modify CopilotKit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps."
href="./custom-look-and-feel/markdown-rendering"
/>
</Cards>
@@ -100,7 +100,7 @@ Before we dive into what agentic copilots are, help us help you by telling us yo
<TailoredContentOption
id="intermediate"
title="I'm already using LangGraph"
description="Help me understand what agentic copilots are, what Copilotkit does to integrate with LangGraph, and how to get started."
description="Help me understand what agentic copilots are, what CopilotKit does to integrate with LangGraph, and how to get started."
icon={<SiLangchain />}
>
@@ -4,15 +4,15 @@ icon: "lucide/Zap"
description: CoAgents support streaming your messages and tool calls to the frontend.
---
If you'd like to change how LangGraph agents behave as CoAgents you can utilize our Copilotkit SDK which provides a collection
of functions and utilities for interacting with the agent's state or behavior. One example of this is the Copilotkit config
If you'd like to change how LangGraph agents behave as CoAgents you can utilize our CopilotKit SDK which provides a collection
of functions and utilities for interacting with the agent's state or behavior. One example of this is the CopilotKit config
which is a wrapper of the LangGraph `config` object. This allows you to extend the configuration of your LangGraph nodes to
change how LangGraph and Copilotkit interact with each other. This allows you to change how messages and tool calls are emitted and
change how LangGraph and CopilotKit interact with each other. This allows you to change how messages and tool calls are emitted and
streamed to the frontend.
## Message Streaming
If you did not change anything in your LangGraph node, message streaming will be on by default. This allows for a message to be
streamed to Copilotkit as it is being generated, allowing for a more responsive experience. However, you can disable this if you
streamed to CopilotKit as it is being generated, allowing for a more responsive experience. However, you can disable this if you
want to have the message only be sent after the agent has finished generating it.
```python
@@ -24,8 +24,8 @@ config = copilotkit_customize_config(
```
## Emitting Tool Calls
Emission of tool calls are off by default. This means that tool calls will not be sent to Copilotkit for processing and rendering.
However, within a node you can extend the LangGraph `config` object to emit tool calls to Copilotkit. This is useful in situations
Emission of tool calls are off by default. This means that tool calls will not be sent to CopilotKit for processing and rendering.
However, within a node you can extend the LangGraph `config` object to emit tool calls to CopilotKit. This is useful in situations
where you may to emit what a potential tool call will look like prior to being executed.
```python
@@ -1,6 +1,6 @@
---
title: LangGraph
description: An agentic framework for building LLM applications that can be used with Copilotkit.
description: An agentic framework for building LLM applications that can be used with CopilotKit.
icon: custom/langchain
---
@@ -8,7 +8,7 @@ icon: custom/langchain
<img src="https://cdn.copilotkit.ai/docs/copilotkit/images/coagents/coagents-highlevel-overview.png" alt="CoAgents High Level Overview" className="mb-10"/>
</Frame>
LangGraph is an agentic framework for building LLM applications that can be used with Copilotkit. It is built on top of LangChain's
LangGraph is an agentic framework for building LLM applications that can be used with CopilotKit. It is built on top of LangChain's
[LangGraph](https://langchain-ai.github.io/langgraph/) library and extends it with additional functionality for building agentic
applications.
@@ -23,7 +23,7 @@ There are some key terms here so let's break them down and understand how they r
- **Stateful**: CoAgents have bi-directional state sharing with the agent and UI. This allows for the agent to remember
information from previous messages and the UI to update the agent with new information. Read more about how state sharing works
[here](/coagents/shared-state).
- **Multi-actor**: CoAgents allow for multiple agents to interact with each other. Copilotkit acts as the "ground-truth"
- **Multi-actor**: CoAgents allow for multiple agents to interact with each other. CopilotKit acts as the "ground-truth"
when transitioning between agents. Read more about how multi-actor workflows work [here](/coagents/multi-agent-flows)
and how messages are managed [here](/coagents/concepts/message-management).
- **LLMs**: CoAgents use large language models to generate responses. This is useful for building applications that need to
@@ -47,7 +47,7 @@ For a quick refresher on each, check out the [Python](https://langchain-ai.githu
## LangGraph Platform
LangGraph Platform is a platform for building and deploying LangGraph applications. It is built on top of the LangGraph library and
allows you to build, manage, and deploy graphs that Copilotkit can interface with. For more information checkout the official
allows you to build, manage, and deploy graphs that CopilotKit can interface with. For more information checkout the official
[LangGraph Platform](https://langchain-ai.github.io/langgraph/concepts/langgraph_platform) documentation.
If you want to take the next step to deploy your LangGraph application as an CoAgent, check out our [quickstart guide](/coagents/quickstart/langgraph).
@@ -34,7 +34,7 @@ HITL combines the efficiency of AI with human judgment, creating a system that's
## How can I use this?
Copilotkit provides two main approaches for HITL LangGraph workflows - interrupt and node-based.
CopilotKit provides two main approaches for HITL LangGraph workflows - interrupt and node-based.
<Callout>
Unsure which approach to use? We recommend starting with the [Interrupt](/coagents/human-in-the-loop/interrupt-flow) flow.
@@ -36,7 +36,7 @@ from using our built-in UI components to fully customizing the UI with headless
<Card
className="border border-gray-300 hover:border-gray-400 transition-colors"
title={<div className="mb-3"><SettingsIcon className="inline mr-2" />Markdown Rendering</div>}
description="Modify Copilotkit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps."
description="Modify CopilotKit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps."
href="./custom-look-and-feel/markdown-rendering"
/>
</Cards>
@@ -100,7 +100,7 @@ Before we dive into what agentic copilots are, help us help you by telling us yo
<TailoredContentOption
id="intermediate"
title="I'm already using Mastra"
description="Help me understand what agentic copilots are, what Copilotkit does to integrate with Mastra, and how to get started."
description="Help me understand what agentic copilots are, what CopilotKit does to integrate with Mastra, and how to get started."
icon={<MastraIcon />}
>
+3 -3
View File
@@ -1,10 +1,10 @@
---
title: Mastra
description: An agentic framework for building LLM applications that can be used with Copilotkit.
description: An agentic framework for building LLM applications that can be used with CopilotKit.
icon: custom/mastra
---
Mastra is an agentic framework for building LLM applications that can be used with Copilotkit. Mastra Agents allow developers
Mastra is an agentic framework for building LLM applications that can be used with CopilotKit. Mastra Agents allow developers
to combine and coordinate tasks efficiently, providing a robust framework for building sophisticated AI automations.
## CoAgents and Mastra
@@ -12,7 +12,7 @@ to combine and coordinate tasks efficiently, providing a robust framework for bu
How do CoAgents extend Mastra?
- **Multi-actor**: CoAgents allow for multiple agents to interact with each other. Copilotkit acts as the "ground-truth"
- **Multi-actor**: CoAgents allow for multiple agents to interact with each other. CopilotKit acts as the "ground-truth"
when transitioning between agents. Read more about how multi-actor workflows work [here](/mastra/multi-agent-flows)
and how messages are managed [here](/mastra/concepts/message-management).
- **LLMs**: CoAgents use large language models to generate responses. This is useful for building applications that need to
@@ -36,7 +36,7 @@ from using our built-in UI components to fully customizing the UI with headless
<Card
className="border border-gray-300 hover:border-gray-400 transition-colors"
title={<div className="mb-3"><SettingsIcon className="inline mr-2" />Markdown Rendering</div>}
description="Modify Copilotkit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps."
description="Modify CopilotKit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps."
href="./custom-look-and-feel/markdown-rendering"
/>
</Cards>
@@ -105,7 +105,7 @@ Pydantic AI is a framework that gives you precise control over AI agents. Pydant
<TailoredContentOption
id="intermediate"
title="I'm already using Pydantic AI"
description="Help me understand what agentic copilots are, what Copilotkit does to integrate with Pydantic AI, and how to get started."
description="Help me understand what agentic copilots are, what CopilotKit does to integrate with Pydantic AI, and how to get started."
icon={<SiLangchain />}
>
@@ -1,6 +1,6 @@
---
title: Pydantic AI
description: An agentic framework for building LLM applications that can be used with Copilotkit.
description: An agentic framework for building LLM applications that can be used with CopilotKit.
icon: custom/pydantic
---
@@ -12,7 +12,7 @@ icon: custom/pydantic
/>
</Frame>
Pydantic AI is an agentic framework for building LLM applications that can be used with Copilotkit. Pydantic AI Agents allow developers
Pydantic AI is an agentic framework for building LLM applications that can be used with CopilotKit. Pydantic AI Agents allow developers
to combine and coordinate coding tasks efficiently, providing a robust framework for building sophisticated AI automations.
## CoAgents and Pydantic AI
@@ -26,7 +26,7 @@ Let's break down some key terms and understand how they relate to and are implem
- ** manage state**: CoAgents have bi-directional state sharing with the agent and UI. This allows for the agent to remember
information from previous messages and the UI to update the agent with new information. Read more about how state sharing works
[here](/pydantic-ai/shared-state).
- **Multi-actor**: CoAgents allow for multiple agents to interact with each other. Copilotkit acts as the "ground-truth"
- **Multi-actor**: CoAgents allow for multiple agents to interact with each other. CopilotKit acts as the "ground-truth"
when transitioning between agents. Read more about how multi-actor workflows work [here](/pydantic-ai/multi-agent-flows).
- **LLMs**: CoAgents use large language models to generate responses. This is useful for building applications that need to
generate natural language responses.
@@ -36,7 +36,7 @@ from using our built-in UI components to fully customizing the UI with headless
<Card
className="border border-gray-300 hover:border-gray-400 transition-colors"
title={<div className="mb-3"><SettingsIcon className="inline mr-2" />Markdown Rendering</div>}
description="Modify Copilotkit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps."
description="Modify CopilotKit's use of markdown to display elements within the assistant arrow text, such as source citing and reasoning steps."
href="./custom-look-and-feel/markdown-rendering"
/>
</Cards>
+13 -13
View File
@@ -3653,11 +3653,11 @@ On this pageCoAgents and LangGraph
# LangGraph
An agentic framework for building LLM applications that can be used with Copilotkit.
An agentic framework for building LLM applications that can be used with CopilotKit.
![CoAgents High Level Overview](https://docs.copilotkit.aihttps://cdn.copilotkit.ai/docs/copilotkit/images/coagents/coagents-highlevel-overview.png)
LangGraph is an agentic framework for building LLM applications that can be used with Copilotkit. It is built on top of LangChain's
LangGraph is an agentic framework for building LLM applications that can be used with CopilotKit. It is built on top of LangChain's
[LangGraph](https://langchain-ai.github.io/langgraph/) library and extends it with additional functionality for building agentic
applications.
@@ -3672,7 +3672,7 @@ There are some key terms here so let's break them down and understand how they r
- **Stateful**: CoAgents have bi-directional state sharing with the agent and UI. This allows for the agent to remember
information from previous messages and the UI to update the agent with new information. Read more about how state sharing works
[here](https://docs.copilotkit.ai/coagents/shared-state).
- **Multi-actor**: CoAgents allow for multiple agents to interact with each other. Copilotkit acts as the "ground-truth"
- **Multi-actor**: CoAgents allow for multiple agents to interact with each other. CopilotKit acts as the "ground-truth"
when transitioning between agents. Read more about how multi-actor workflows work [here](https://docs.copilotkit.ai/coagents/multi-agent-flows)
and how messages are managed [here](https://docs.copilotkit.ai/coagents/concepts/message-management).
- **LLMs**: CoAgents use large language models to generate responses. This is useful for building applications that need to
@@ -3697,7 +3697,7 @@ For a quick refresher on each, check out the [Python](https://langchain-ai.githu
## [LangGraph Platform](https://docs.copilotkit.ai/coagents/concepts/langgraph\#langgraph-platform)
LangGraph Platform is a platform for building and deploying LangGraph applications. It is built on top of the LangGraph library and
allows you to build, manage, and deploy graphs that Copilotkit can interface with. For more information checkout the official
allows you to build, manage, and deploy graphs that CopilotKit can interface with. For more information checkout the official
[LangGraph Platform](https://langchain-ai.github.io/langgraph/concepts/langgraph_platform) documentation.
If you want to take the next step to deploy your LangGraph application as an CoAgent, check out our [quickstart guide](https://docs.copilotkit.ai/coagents/quickstart/langgraph).
@@ -4520,7 +4520,7 @@ Help me understand what agentic copilots are, where LangGraph fits in, and how t
I'm already using LangGraph
Help me understand what agentic copilots are, what Copilotkit does to integrate with LangGraph, and how to get started.
Help me understand what agentic copilots are, what CopilotKit does to integrate with LangGraph, and how to get started.
![CoAgents Shared State](https://docs.copilotkit.aihttps://cdn.copilotkit.ai/docs/copilotkit/images/coagents/SharedStateCoAgents.gif)
@@ -6063,7 +6063,7 @@ Chat with an Agent](https://docs.copilotkit.ai/crewai-flows/agentic-chat-ui)
![](https://static.scarf.sh/a.png?x-pxid=ffc9f65d-0186-4575-b065-61d62ea9d7d3)
## Copilotkit Configuration Guide
## CopilotKit Configuration Guide
CrewAI CrewAI support is here! Checkout the [Crew](https://docs.copilotkit.ai/crewai-crews) and [Flow](https://docs.copilotkit.ai/crewai-flows) documentation.
Search docs
@@ -6076,16 +6076,16 @@ On this pageMessage Streaming
CoAgents support streaming your messages and tool calls to the frontend.
If you'd like to change how LangGraph agents behave as CoAgents you can utilize our Copilotkit SDK which provides a collection
of functions and utilities for interacting with the agent's state or behavior. One example of this is the Copilotkit config
If you'd like to change how LangGraph agents behave as CoAgents you can utilize our CopilotKit SDK which provides a collection
of functions and utilities for interacting with the agent's state or behavior. One example of this is the CopilotKit config
which is a wrapper of the LangGraph `config` object. This allows you to extend the configuration of your LangGraph nodes to
change how LangGraph and Copilotkit interact with each other. This allows you to change how messages and tool calls are emitted and
change how LangGraph and CopilotKit interact with each other. This allows you to change how messages and tool calls are emitted and
streamed to the frontend.
## [Message Streaming](https://docs.copilotkit.ai/coagents/concepts/copilotkit-config\#message-streaming)
If you did not change anything in your LangGraph node, message streaming will be on by default. This allows for a message to be
streamed to Copilotkit as it is being generated, allowing for a more responsive experience. However, you can disable this if you
streamed to CopilotKit as it is being generated, allowing for a more responsive experience. However, you can disable this if you
want to have the message only be sent after the agent has finished generating it.
```
@@ -6098,8 +6098,8 @@ config = copilotkit_customize_config(
## [Emitting Tool Calls](https://docs.copilotkit.ai/coagents/concepts/copilotkit-config\#emitting-tool-calls)
Emission of tool calls are off by default. This means that tool calls will not be sent to Copilotkit for processing and rendering.
However, within a node you can extend the LangGraph `config` object to emit tool calls to Copilotkit. This is useful in situations
Emission of tool calls are off by default. This means that tool calls will not be sent to CopilotKit for processing and rendering.
However, within a node you can extend the LangGraph `config` object to emit tool calls to CopilotKit. This is useful in situations
where you may to emit what a potential tool call will look like prior to being executed.
```
@@ -7212,7 +7212,7 @@ HITL combines the efficiency of AI with human judgment, creating a system that's
## [How can I use this?](https://docs.copilotkit.ai/coagents/human-in-the-loop\#how-can-i-use-this)
Copilotkit provides two main approaches for HITL LangGraph workflows - interrupt and node-based.
CopilotKit provides two main approaches for HITL LangGraph workflows - interrupt and node-based.
Unsure which approach to use? We recommend starting with the [Interrupt](https://docs.copilotkit.ai/coagents/human-in-the-loop/interrupt-flow) flow.
+1 -1
View File
@@ -48,7 +48,7 @@
- [Multi-Agent Flows](https://docs.copilotkit.ai/coagents/multi-agent-flows): Learn to orchestrate complex flows with multiple agents.
- [Copilot Sidebar Component](https://docs.copilotkit.ai/reference/components/chat/CopilotSidebar): Customizable sidebar component for chatbot interactions in CopilotKit.
- [CrewAI Quickstart Guide](https://docs.copilotkit.ai/crewai-flows/quickstart/crewai): Quickly set up CrewAI Flows with CopilotKit integration.
- [Copilotkit Configuration Guide](https://docs.copilotkit.ai/coagents/concepts/copilotkit-config): Learn to configure message streaming and tool calls in Copilotkit.
- [CopilotKit Configuration Guide](https://docs.copilotkit.ai/coagents/concepts/copilotkit-config): Learn to configure message streaming and tool calls in CopilotKit.
- [Agentic Chat UI](https://docs.copilotkit.ai/coagents/agentic-chat-ui): Explore CopilotKit's agentic chat UI components for user interaction.
- [CrewAIAgent Overview](https://docs.copilotkit.ai/reference/sdk/python/CrewAIAgent): Define and serve agents using CrewAIAgent in Python.
- [CrewAI Quickstart Guide](https://docs.copilotkit.ai/crewai-crews/quickstart/crewai): Quickly set up CrewAI Crews with CopilotKit integration.
@@ -254,7 +254,7 @@ If you are not sure yet, simply ignore this note.
import { Request, Response } from 'express';
@Controller()
export class CopilotkitController {
export class CopilotKitController {
@All('/copilotkit')
copilotkit(@Req() req: Request, @Res() res: Response) {
{{adapterSetup}}
@@ -212,7 +212,7 @@ import { RiNextjsLine } from "react-icons/ri";
import OpenAI from "openai";
@Controller()
export class CopilotkitController {
export class CopilotKitController {
@All('/copilotkit')
copilotkit(@Req() req: Request, @Res() res: Response) {
const openai = new OpenAI({ apiKey: process.env.OPENAI_API_KEY });
@@ -180,7 +180,7 @@ import { RiNextjsLine } from "react-icons/ri";
@Controller()
export class CopilotkitController {
export class CopilotKitController {
@All('/copilotkit')
copilotkit(@Req() req: Request, @Res() res: Response) {
const serviceAdapter = new ExperimentalEmptyAdapter();
@@ -1,6 +1,6 @@
# use-trips.tsx
This hook is where most of the magic happens for Copilotkit (if you're looking for the rest, check out [app/page.tsx](../../app/page.tsx) and [api/copilotkit/route.ts](../../app/api/copilotkit/route.ts)). It handles interacting with the CoAgent's state and provides helper functions for the UI to interact with and update the CoAgent's state. It also provides intermediate streaming for human-in-the-loop components as well as progress tracking.
This hook is where most of the magic happens for CopilotKit (if you're looking for the rest, check out [app/page.tsx](../../app/page.tsx) and [api/copilotkit/route.ts](../../app/api/copilotkit/route.ts)). It handles interacting with the CoAgent's state and provides helper functions for the UI to interact with and update the CoAgent's state. It also provides intermediate streaming for human-in-the-loop components as well as progress tracking.
## Key Concepts
@@ -43,7 +43,7 @@ This hook is used to add front-end functions as tool calls to an agent or LLM. T
For our needs, we can keep it simple and think of it as a way to force the LLM for user approval before performing some action. This is accomplished two ways.
1. Setting a "breakpoint" in the agent code via the `interrupt_after` option when compiling an agent.
2. Emitting tool calls via the Copilotkit SDK.
2. Emitting tool calls via the CopilotKit SDK.
3. Sending approval/rejection response back to the agent via our `useCopilotAction` hook.
This is gone into in more detail in our documentation on implementing [human in the loop](https://docs.copilotkit.ai/coagents/human-in-the-loop/node-flow).