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.

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 create

The 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 install

Configure your environment

Create a .env file in your agent directory and add your OpenAI API key:

agent/.env
OPENAI_API_KEY=your_openai_api_key
What 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 the development server

npm run dev

This will start both the UI and agent servers concurrently.

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!

Open Inspector and confirm setup

On localhost, click the Inspector button in the corner of the app.

  1. Open Inspect, then Agent. Your agent is listed.
  2. Send a chat message. Open Inspect, then AG-UI Events. Events are moving.
  3. 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:

How is this guide?