Quickstart
Turn your Agent Spec agent into an agent‑native application in minutes.
Prerequisites
- Node.js 20+
- Python 3.9+
1) Scaffold the UI
Start from our starter template:
npx copilotkit@latest create -f agent-spec2) Run your Agent‑Spec server
Use the FastAPI example or your own server with the Agent‑Spec endpoint mounted at /copilotkit:
python server.py
# Requires AGENT_SPEC_PATH pointing to an Agent‑Spec JSON/YAML file3) Connect the UI to your server
Set the endpoint in your Next.js app:
COPILOTKIT_REMOTE_ENDPOINT=http://localhost:8000/copilotkit4) Run Next.js
pnpm dev
# or npm run dev / yarn dev / bun devOpen http://localhost:3000 and start chatting with your agent.
Notes
- The template uses CopilotKit Runtime to proxy to your FastAPI endpoint.
- AG‑UI streaming covers text, tool calls, tool results, and run lifecycle.
Learn more
- Agent Spec docs home: https://oracle.github.io/agent-spec/development/docs_home.html
- Specification overview: https://oracle.github.io/agent-spec/development/agentspec/index.html
