This is the assistant-ui minimal starter project.

Getting Started#

1. Configure Environment Variables#

Add your OpenAI API key to a .env.local file:

OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

2. Install Dependencies#

npm install
# or
yarn install
# or
pnpm install

3. Run the Development Server#

npm run dev
# or
yarn dev
# or
pnpm dev

Open http://localhost:3000 with your browser to see the result.

Development#

You can start customizing the UI by modifying components in the components/assistant-ui/ directory.

To add more assistant-ui components:

npx assistant-ui add

Key Files#

• app/assistant.tsx - Sets up the runtime provider
• app/api/chat/route.ts - Chat API endpoint
• components/assistant-ui/thread.tsx - Chat thread component