https://github.com/openai/openai-assistants-quickstart
OpenAI Assistants API quickstart with Next.js.
https://github.com/openai/openai-assistants-quickstart
Last synced: 1 day ago
JSON representation
OpenAI Assistants API quickstart with Next.js.
- Host: GitHub
- URL: https://github.com/openai/openai-assistants-quickstart
- Owner: openai
- License: mit
- Created: 2024-05-01T19:48:19.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-03-07T18:50:12.000Z (about 1 month ago)
- Last Synced: 2025-03-31T01:00:43.518Z (16 days ago)
- Language: TypeScript
- Homepage: https://platform.openai.com/docs/assistants
- Size: 36.1 KB
- Stars: 1,802
- Watchers: 94
- Forks: 502
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ChatGPT-repositories - openai-assistants-quickstart - OpenAI Assistants API quickstart with Next.js. (Chatbots)
README
# OpenAI Assistants API Quickstart
A quick-start template using the OpenAI [Assistants API](https://platform.openai.com/docs/assistants/overview) with [Next.js](https://nextjs.org/docs).
## Quickstart Setup
### 1. Clone repo
```shell
git clone https://github.com/openai/openai-assistants-quickstart.git
cd openai-assistants-quickstart
```
### 2. Set your [OpenAI API key](https://platform.openai.com/api-keys)
```shell
export OPENAI_API_KEY="sk_..."
```
(or in `.env.example` and rename it to `.env`).
### 3. Install dependencies
```shell
npm install
```
### 4. Run
```shell
npm run dev
```
### 5. Navigate to [http://localhost:3000](http://localhost:3000).
## Deployment
You can deploy this project to Vercel or any other platform that supports Next.js.
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fopenai%2Fopenai-assistants-quickstart&env=OPENAI_API_KEY,OPENAI_ASSISTANT_ID&envDescription=API%20Keys%20and%20Instructions&envLink=https%3A%2F%2Fgithub.com%2Fopenai%2Fopenai-assistants-quickstart%2Fblob%2Fmain%2F.env.example)
## Overview
This project is intended to serve as a template for using the Assistants API in Next.js with [streaming](https://platform.openai.com/docs/assistants/overview/step-4-create-a-run), tool use ([code interpreter](https://platform.openai.com/docs/assistants/tools/code-interpreter) and [file search](https://platform.openai.com/docs/assistants/tools/file-search)), and [function calling](https://platform.openai.com/docs/assistants/tools/function-calling). While there are multiple pages to demonstrate each of these capabilities, they all use the same underlying assistant with all capabilities enabled.
The main logic for chat will be found in the `Chat` component in `app/components/chat.tsx`, and the handlers starting with `api/assistants/threads` (found in `api/assistants/threads/...`). Feel free to start your own project and copy some of this logic in! The `Chat` component itself can be copied and used directly, provided you copy the styling from `app/components/chat.module.css` as well.
### Pages
- Basic Chat Example: [http://localhost:3000/examples/basic-chat](http://localhost:3000/examples/basic-chat)
- Function Calling Example: [http://localhost:3000/examples/function-calling](http://localhost:3000/examples/function-calling)
- File Search Example: [http://localhost:3000/examples/file-search](http://localhost:3000/examples/file-search)
- Full-featured Example: [http://localhost:3000/examples/all](http://localhost:3000/examples/all)
### Main Components
- `app/components/chat.tsx` - handles chat rendering, [streaming](https://platform.openai.com/docs/assistants/overview?context=with-streaming), and [function call](https://platform.openai.com/docs/assistants/tools/function-calling/quickstart?context=streaming&lang=node.js) forwarding
- `app/components/file-viewer.tsx` - handles uploading, fetching, and deleting files for [file search](https://platform.openai.com/docs/assistants/tools/file-search)
### Endpoints
- `api/assistants` - `POST`: create assistant (only used at startup)
- `api/assistants/threads` - `POST`: create new thread
- `api/assistants/threads/[threadId]/messages` - `POST`: send message to assistant
- `api/assistants/threads/[threadId]/actions` - `POST`: inform assistant of the result of a function it decided to call
- `api/assistants/files` - `GET`/`POST`/`DELETE`: fetch, upload, and delete assistant files for file search
## Feedback
Let us know if you have any thoughts, questions, or feedback in [this form](https://docs.google.com/forms/d/e/1FAIpQLScn_RSBryMXCZjCyWV4_ebctksVvQYWkrq90iN21l1HLv3kPg/viewform?usp=sf_link)!