Responses starter app

This repository contains a NextJS starter app built on top of the Responses API. It leverages built-in tools (web search and file search) and implements a chat interface with multi-turn conversation handling.

Features:

• Multi-turn conversation handling
• Web search tool configuration
• Vector store creation & file upload for use with the file search tool
• Function calling
• Streaming responses & tool calls
• Display annotations

This app is meant to be used as a starting point to build a conversational assistant that you can customize to your needs.

How to use

1. Set up the OpenAI API:

   • If you're new to the OpenAI API, sign up for an account.
   • Follow the Quickstart to retrieve your API key.

2. Set the OpenAI API key:

   2 options:

   • Set the OPENAI_API_KEY environment variable globally in your system
   • Set the OPENAI_API_KEY environment variable in the project: Create a .env file at the root of the project and add the following line (see .env.example for reference):

   OPENAI_API_KEY=<your_api_key>

3. Clone the Repository:

   git clone https://github.com/openai/openai-responses-starter-app.git

4. Install dependencies:

   Run in the project root:

   npm install

5. Run the app:

   npm run dev

   The app will be available at http://localhost:3000.

Contributing

You are welcome to open issues or submit PRs to improve this app, however, please note that we may not review all suggestions.

License

This project is licensed under the MIT License. See the LICENSE file for details.