ChatKit TypeScript SDK Documentation

Welcome to the ChatKit TypeScript SDK documentation! This documentation will help you build powerful chat-based applications with streaming responses, interactive widgets, and flexible storage.

Documentation Index

Getting Started

• Main Documentation - Overview, installation, quick start, and core concepts
• API Reference - Complete API documentation for all classes and functions

Core Topics

• Widgets - Building interactive UI components with widgets
• Stores - Implementing persistence layers for threads and attachments
• Agents - Integrating with OpenAI Agents SDK

Quick Navigation

For Beginners

1. Start with the Main Documentation to understand the core concepts
2. Review the Widgets Guide to learn about building UIs
3. Check out the Examples section for code samples

For Implementation

1. Read the Stores Documentation to implement persistence
2. Review the API Reference for method signatures
3. Follow the Agents Guide for agent integration

For Advanced Usage

1. Study Custom Store Implementation
2. Learn about Streaming Widgets
3. Explore Advanced Agent Topics

Documentation Structure

docs/
├── README.md           # This file
├── index.md            # Main documentation and getting started
├── api-reference.md    # Complete API reference
├── widgets.md          # Widget system documentation
├── stores.md           # Store interface and implementations
└── agents.md           # Agent integration guide

Key Concepts

Threads and Messages

Threads are conversation containers that hold messages, widgets, and other items. Learn more in the Main Documentation.

Widgets

Widgets are declarative UI components that can be streamed and updated in real-time. See Widgets Documentation for details.

Stores

Stores handle persistence of threads, messages, and attachments. Learn how to implement custom stores in Stores Documentation.

Agents

Agents enable AI-powered conversations using the OpenAI Agents SDK. See Agents Documentation for integration details.

Examples

Example code is provided throughout the documentation. Key examples include:

• Basic Server Setup
• Widget Streaming
• Agent Integration
• Custom Store
• Custom Converter

Additional Resources

• Check the example/ directory in the repository for complete working examples
• Review the TypeScript source code for detailed type definitions
• See test files in tests/ for usage patterns

Contributing

Found an error or want to improve the documentation? Contributions are welcome! Please:

1. Check existing issues
2. Follow the documentation style
3. Include code examples where helpful
4. Test all code samples before submitting

Support

For questions and issues:

• Check the API Reference for method details
• Review Examples for common patterns
• Open an issue on GitHub for bugs or feature requests