openai-responses-starter-app  by openai

NextJS starter app for building conversational assistants

Created 6 months ago
618 stars

Top 53.3% on SourcePulse

GitHubView on GitHub
Project Summary

This repository provides a Next.js starter application for building conversational assistants using the OpenAI Responses API. It targets developers looking to quickly prototype and customize AI-powered chat interfaces with features like multi-turn conversations, web search, and file-based knowledge retrieval.

How It Works

The app leverages the OpenAI Responses API to manage chat interactions, enabling features such as multi-turn conversation handling, function calling, and streaming responses. It integrates built-in tools for web and file search, allowing the assistant to access external information and user-provided documents. A vector store can be created for efficient file searching.

Quick Start & Requirements

  • Primary install / run command: npm install followed by npm run dev.
  • Prerequisites: OpenAI API key (set as OPENAI_API_KEY environment variable or in a .env file).
  • The app will be available at http://localhost:3000.
  • Official Quickstart: https://platform.openai.com/docs/quickstart

Highlighted Details

  • Implements multi-turn conversation handling.
  • Integrates web search and file search tools.
  • Supports function calling and streaming responses.
  • Includes vector store creation and file upload functionality.

Maintenance & Community

This is an official starter app from OpenAI. Contributions via issues or PRs are welcome, though review is not guaranteed.

Licensing & Compatibility

  • License: MIT License.
  • Compatible with commercial use and closed-source linking.

Limitations & Caveats

The repository is a starter app and may require significant customization for production use. OpenAI may not review all community contributions.

Health Check
Last Commit

2 weeks ago

Responsiveness

1 day

Pull Requests (30d)
4
Issues (30d)
3
Star History
206 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.