# Docs

- [Introduction](/docs/introduction): The open-source infrastructure for production AI agents and knowledge bases.
- [Install](/docs/install): Get OpenAgent running and send your first AI-powered message in under 5 minutes.

- **Guides**
- [Build a Chat Assistant](/docs/build-a-chat-assistant): Create a chat assistant backed by any LLM provider.
- [Add a Knowledge Base](/docs/add-a-knowledge-base): Enable RAG so your assistant answers from your own documents.
- [Tools & Automation](/docs/tools-and-automation): Give your assistant the ability to act - browse the web, call APIs, or run automations.

- **References**
- Chat
  - [Chat](/docs/chat): How conversation works in OpenAgent — request lifecycle, Message records, feedback, and suggestions.
  - [Agent Configuration](/docs/chat/agent-configuration): Store fields that control conversation behavior — prompt, memory, rate limiting, suggestions, and content filtering.
  - [Voice Input](/docs/chat/voice-input): How users dictate messages by voice in OpenAgent — browser built-in recognition, cloud streaming STT, and silence auto-stop.
- Basic
  - [Stores](/docs/basic/stores): Complete field reference for the Store — the central unit of AI orchestration in OpenAgent.
  - [Chats](/docs/basic/chats): Conversation sessions in OpenAgent and how they relate to Stores and Messages.
  - [Messages](/docs/basic/messages): Per-turn records inside a Chat, including the response, retrieval context, and tool activity.
  - [Notifications](/docs/basic/notifications): The in-app notification inbox that keeps users updated on the Stores they watch.
- Agent Page
  - [Agent Page](/docs/agent-page): The public detail page for a published agent — header actions, tabs, and deep-linking.
  - [Overview](/docs/agent-page/overview): The default Agent page tab — file tree, description, and comments.
  - [Chat](/docs/agent-page/chat): Start a conversation with an agent without leaving its page.
  - [Files](/docs/agent-page/files): Browse an agent's knowledge base files from its page.
  - [Issues](/docs/agent-page/issues): A GitHub-style discussion board scoped to an agent.
  - [Security](/docs/agent-page/security): A configuration and activity security audit for an agent.
  - [Insights](/docs/agent-page/insights): Usage analytics for an agent — Pulse, Contributors, Traffic, and more.
  - [Settings](/docs/agent-page/settings): The owner-only configuration tab on the Agent page.
- Knowledge Base
  - [Files](/docs/knowledge-base/files): Uploading, managing, and troubleshooting document ingestion in a Store.
  - [Vectors](/docs/knowledge-base/vectors): How document chunks are embedded, stored, and searched for knowledge base retrieval.
  - [Resources](/docs/knowledge-base/resources): Supporting knowledge assets and related objects exposed alongside Files and Vectors.
- Connectors
  - Providers
    - [Model Providers](/docs/connectors/providers/model-providers): Connect and orchestrate Large Language Models within the OpenAgent infrastructure.
    - [Embedding Providers](/docs/connectors/providers/embedding-providers): Vector embedding services for knowledge base retrieval — configuration, model selection, and consistency rules.
    - [Storage Providers](/docs/connectors/providers/storage-providers): Where uploaded file bytes are physically stored — local disk or Alibaba Cloud OSS.
  - Tools
    - [Built-in Tools](/docs/connectors/tools/builtin-tools): Tools that ship with OpenAgent and can be enabled per Store without any external server.
  - Pipes
    - [Pipes](/docs/connectors/pipes): Connect external messaging channels to OpenAgent agents.
    - [Telegram](/docs/connectors/pipes/telegram): Connect a Telegram bot to an OpenAgent Store.
    - [Discord](/docs/connectors/pipes/discord): Connect a Discord bot to an OpenAgent Store.
    - [Slack](/docs/connectors/pipes/slack): Connect a Slack app to an OpenAgent Store.
    - [WhatsApp](/docs/connectors/pipes/whatsapp): Connect the WhatsApp Cloud API to an OpenAgent Store.
    - [Facebook Messenger](/docs/connectors/pipes/facebook-messenger): Connect Facebook Messenger to an OpenAgent Store.
    - [Threads](/docs/connectors/pipes/threads): Connect Meta Threads to an OpenAgent Store.
    - [WeChat](/docs/connectors/pipes/wechat): Connect a WeChat Official Account to an OpenAgent Store.
    - [Weixin Claw](/docs/connectors/pipes/weixin-claw): Connect a personal WeChat account to an OpenAgent Store by scanning a QR code.
    - [Snapchat](/docs/connectors/pipes/snapchat): Connect a Snapchat bot to an OpenAgent Store.
    - [X Direct Messages](/docs/connectors/pipes/x-direct-messages): Connect X (Twitter) Direct Messages to an OpenAgent Store.
  - [MCP Servers](/docs/connectors/mcp-servers): Connect any MCP-compatible tool server to your OpenAgent agents.
- Auditing Logs
  - [Logs](/docs/auditing-logs/logs): Audit records, conversation history, and token/cost tracking for operational visibility.
  - [Sessions](/docs/auditing-logs/sessions): User login sessions, active access, and operational session management.
- Admin
  - [Settings](/docs/admin/settings): Configure branding, authentication, navigation, and runtime options for the OpenAgent site.
  - [Resources](/docs/admin/resources): Manage files and documents in the knowledge base.
  - [AI Usage](/docs/admin/ai-usage): Token consumption, cost trends, and usage visibility across stores and providers.
  - [Visitors](/docs/admin/visitors): Recent system actions and operational activity across the platform.
  - [System Info](/docs/admin/system-info): Runtime and deployment-level information about the current OpenAgent instance.
  - [Swagger](/docs/admin/swagger): The API explorer for inspecting and testing OpenAgent endpoints.
  - [Enterprise SSO](/docs/admin/enterprise-sso): User accounts, roles, SSO integration, and organization management in OpenAgent.