Summary

This repository provides an advanced starter application and playground for building with the OpenAI ChatKit SDK. It features a full-stack architecture combining a FastAPI backend with a Vite + React frontend, demonstrating ChatKit UI components, widgets, and client tools. The project is ideal for developers looking to quickly prototype or build sophisticated chat interfaces powered by OpenAI's agent and language models, offering pre-built examples for common use cases.

How It Works

The project utilizes a FastAPI backend, powered by the ChatKit Python SDK and OpenAI Agents SDK, to handle core logic and agent interactions. A Vite-based React frontend provides the user interface, integrating ChatKit UI elements and widgets. The development setup allows seamless tandem development, with the Vite server proxying requests to the local FastAPI instance. Agent tools like get_weather, switch_theme, and record_fact are implemented, showcasing interactive capabilities within the chat interface.

Quick Start & Requirements

• Primary install/run command: From the repository root, run npm start to launch both backend and frontend. Alternatively, use npm run backend and npm run frontend separately.
• Prerequisites: uv (Python package manager), Node.js/npm, and an OPENAI_API_KEY environment variable.
• Development URLs: Backend typically runs on http://127.0.0.1:8000, Frontend on http://127.0.0.1:5170.
• Links: The README provides detailed manual setup steps for backend and frontend, and configuration details for production deployment.

Highlighted Details

• Demonstrates ChatKit UI, widgets, and client tools integration.
• Includes pre-built agent tools: get_weather (widget), switch_theme, record_fact.
• Features three advanced example applications: Customer Support, Knowledge Assistant (with OpenAI File Search), and Marketing Assets.
• Supports local development with hot-reloading via uvicorn and Vite.

Maintenance & Community

No specific details regarding maintainers, community channels (like Discord/Slack), or roadmap were found in the provided README.

Licensing & Compatibility

The license type is not explicitly stated in the provided README content. Compatibility for commercial use or closed-source linking would require clarification of the underlying ChatKit and OpenAI SDK licenses.

Limitations & Caveats

Production deployment requires careful configuration, including hosting the frontend separately, domain allowlisting, and setting specific environment variables (VITE_CHATKIT_API_DOMAIN_KEY). The project relies heavily on external OpenAI API keys and services.