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. Cloud-hosted setup uses a server-side project API key and does not issue COPILOTKIT_LICENSE_TOKEN. 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.
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.
Setup frontend actions
Give your agent the ability to call frontend tools, directly updating your application.