# OpenChat

## Docs

- [API Reference Overview](https://docs.osschat.dev/api-reference/introduction.md): Server route APIs exposed by the OpenChat web app.
- [GET /api/models](https://docs.osschat.dev/api-reference/models-endpoint.md): Cached and rate-limited model catalog proxy for OpenRouter models.
- [/api/openrouter-key](https://docs.osschat.dev/api-reference/openrouter-key-endpoint.md): Store and check user OpenRouter key presence without exposing raw key material.
- [/api/provider-credentials](https://docs.osschat.dev/api-reference/provider-credentials-endpoint.md): Manage encrypted user provider credentials.
- [/api/workflow/*](https://docs.osschat.dev/api-reference/workflows-endpoints.md): Workflow endpoints for title generation, export, cleanup, and account deletion.
- [Development Workflows](https://docs.osschat.dev/development.md): Day-to-day contributor workflows for OpenChat.
- [Chat Experience](https://docs.osschat.dev/features/chat-experience.md): Core chat behavior including send, stream, edit, retry, fork, and navigation.
- [Files and Exports](https://docs.osschat.dev/features/files-and-exports.md): File attachments, upload metadata, and chat export workflows.
- [Model Selection](https://docs.osschat.dev/features/model-selection.md): How users choose models, providers, and reasoning preferences.
- [Settings and Shortcuts](https://docs.osschat.dev/features/settings-and-shortcuts.md): Account, providers, models, chat preferences, and keyboard actions.
- [Web Search and Reasoning](https://docs.osschat.dev/features/web-search-and-reasoning.md): Optional tool use and model reasoning behavior in OpenChat streams.
- [AI Models & Chat](https://docs.osschat.dev/guides/ai-models.md): How OpenChat integrates with OpenRouter for AI model access
- [Architecture](https://docs.osschat.dev/guides/architecture.md): OpenChat architecture across frontend, server routes, Convex, and external services.
- [Authentication](https://docs.osschat.dev/guides/authentication.md): Better Auth + GitHub OAuth flow in OpenChat.
- [Contributing](https://docs.osschat.dev/guides/contributing.md): How to contribute to OpenChat development
- [Providers and Encryption](https://docs.osschat.dev/guides/providers-and-encryption.md): Provider credential model, encrypted secret handling, and provider runtime routing.
- [Introduction](https://docs.osschat.dev/index.md): OpenChat is an open-source AI chat platform with real-time sync, multi-provider model access, and self-hosting support.
- [Quickstart](https://docs.osschat.dev/quickstart.md): Run OpenChat locally with Bun, Convex, and GitHub OAuth.
- [Docker Deployment](https://docs.osschat.dev/self-hosting/docker.md): Run OpenChat in containers using Docker Compose.
- [Environment Variables](https://docs.osschat.dev/self-hosting/environment.md): Required and optional configuration for OpenChat deployments.
- [Self-Hosting Overview](https://docs.osschat.dev/self-hosting/overview.md): Deployment options and architecture decisions for self-hosting OpenChat.
- [Vercel + Convex Cloud](https://docs.osschat.dev/self-hosting/vercel-convex.md): Deploy OpenChat with managed hosting on Vercel and Convex Cloud.

## OpenAPI Specs

- [openapi](https://docs.osschat.dev/api-reference/openapi.json)

## Optional

- [GitHub](https://github.com/opencoredev/openchat)
- [Try OpenChat](https://osschat.dev)