Quickstart
Turn your Pydantic AI agent into an agent-native application in 10 minutes.
Start with your coding agent
Use this prompt to connect your Pydantic AI 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.12+
- 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 Pydantic AI agent.
Run our CLI
npx copilotkit@latest createThe CLI walks you through:
- Project name
- CopilotKit Intelligence: persistent threads and the inspector. Choose Yes to scaffold a project pre-wired for the platform (the CLI walks you through sign-up, or you can create an account first), or No for a standard Pydantic AI setup.
- Framework: pick Pydantic AI 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 uses OpenAI's gpt-6-luna by default. To use another model, add COPILOTKIT_AGENT_MODEL=<provider>:<model> to .env. The provider is openai, anthropic, or google.
Start chatting
Your AI agent is now ready to use. Navigate to localhost:3000 and try asking it some questions:
- Can you tell me a joke?
- Can you help me understand AI?
- What do you think about React?
- If the runtime cannot reach the agent, make sure that
uv run main.pyis running and that the route URL ishttp://localhost:8000/. - If the agent does not answer, make sure that
OPENAI_API_KEYis set in the agent's environment. - If the route fails to import
HttpAgent, install@ag-ui/clientin your frontend.
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.
Setup frontend actions
Give your agent the ability to call frontend tools, directly updating your application.
How is this guide?