Quickstart
Turn your LlamaIndex Agents into an agent-native application in 10 minutes.
Start with your coding agent
Use this prompt to connect your LlamaIndex agent to CopilotKit and verify a working conversation. Your coding agent will follow this guide in your project, or you can work through the manual steps below.
Open your coding agent in your project's folder, or in an empty folder for a new app.This runs in a coding agent on your computer.
Prerequisites
Before you begin, you'll need the following:
- An OpenAI API key
- Node.js 20+
- Python 3.10+
- Your favorite package manager
Getting started
Set up CopilotKit Intelligence
Sign in to cloud-hosted Intelligence. You will connect the app after you create it below.
Choose your starting point
You can either start fresh with our starter template or integrate CopilotKit into your existing LlamaIndex agent.
Run our CLI
npx copilotkit@latest createThe CLI walks you through:
- Project name
- CopilotKit Intelligence: persistent threads and the Inspector. Choose Yes for a project that is wired to Intelligence. Choose No for a standard LlamaIndex setup. If you choose Yes, the CLI walks you through sign-up.
- Framework: pick LlamaIndex when prompted.
Install dependencies
npm installConfigure your environment
Create a .env file in your agent directory and add your OpenAI API key:
OPENAI_API_KEY=your_openai_api_keyWhat about other models?
The starter template uses OpenAI's gpt-6-luna by default, but you can modify it to use any language model supported by LlamaIndex.
Start chatting
Your AI agent is now ready to use. Navigate to localhost:3000 and start prompting it:
What tools do you have access to?What do you think about React?Show me some cool things you can do!- If the chat cannot connect to the agent, use
0.0.0.0or127.0.0.1instead oflocalhost. - If the chat shows a connection error, make sure that the
agentlines in thenpm run devoutput showUvicorn running on http://127.0.0.1:9000. - If the
agentlines show an OpenAIAuthenticationError, make sure thatOPENAI_API_KEYinagent/.envholds a valid key.
Open Inspector and confirm setup
On localhost, click the Inspector button in the corner of the app.
- Open Inspect, then Agent. Your agent is listed.
- Send a chat message. Open Inspect, then AG-UI Events. Events are moving.
- Open Rich Threads. The list is unlocked (Intelligence is on), or locked with Copy setup prompt (Intelligence is off).
More detail: Inspector.
What's next?
Now that you have your basic agent setup, explore these advanced features:
Implement Human in the Loop
Allow your users and agents to collaborate together on tasks.
Utilize the Shared State
Learn how to synchronize your agent's state with your UI's state, and vice versa.
Add some generative UI
Render your agent's progress and output in the UI.
Add frontend tools
Give your agent the ability to call frontend tools, directly updating your application.
How is this guide?