RepoOpenAIOpenAIpublished May 1, 2024seen 6d

openai/openai-assistants-quickstart

TypeScript

Open original ↗

Captured source

source ↗
GH
GitHub/github.com/openai/openai-assistants-quickstart
openai/openai-assistants-quickstart repository metadata
Source ↗
published May 1, 2024seen 6dcaptured 8hhttp 200method plain

openai/openai-assistants-quickstart

Description: OpenAI Assistants API quickstart with Next.js.

Language: TypeScript

License: MIT

Stars: 1962

Forks: 577

Open issues: 24

Created: 2024-05-01T19:48:19Z

Pushed: 2025-03-07T18:50:12Z

Default branch: main

Fork: no

Archived: no

README:

OpenAI Assistants API Quickstart

A quick-start template using the OpenAI Assistants API with Next.js.

!OpenAI Assistants API Quickstart

Quickstart Setup

1. Clone repo

git clone https://github.com/openai/openai-assistants-quickstart.git
cd openai-assistants-quickstart

2. Set your OpenAI API key

export OPENAI_API_KEY="sk_..."

(or in .env.example and rename it to .env).

3. Install dependencies

npm install

4. Run

npm run dev

5. Navigate to http://localhost:3000.

Deployment

You can deploy this project to Vercel or any other platform that supports Next.js.

![Deploy with Vercel](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, tool use (code interpreter and file search), and 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

Main Components

  • app/components/chat.tsx - handles chat rendering, streaming, and function call forwarding
  • app/components/file-viewer.tsx - handles uploading, fetching, and deleting files for 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!