Documentation Index

Complete index of all documentation in the Omi codebase.

Getting Started

• Introduction - Welcome to Omi
• Quick Start - Get started quickly
• Chat Tips - Tips for using Omi chat

Developer Documentation

Setup

• App Setup - Set up Flutter app for development
• Backend Setup - Set up backend infrastructure
• Backend Deep Dive - Backend architecture overview
• Backend Chat System - Chat system architecture
• Storing Conversations - Data storage patterns
• Transcription - Speech-to-text processing

Protocol & Integration

• Protocol - BLE protocol specification
• Cursor Configuration - How .cursor/ configures rules, skills, and agents
• MCP - Model Context Protocol server
• Contribution - How to contribute

API Documentation

• API Overview - Developer API introduction
• Memories API - Memory operations
• Conversations API - Conversation operations
• Action Items API - Action item operations
• Keys API - API key management

App Development

• Apps Introduction - Building apps for Omi
• Prompt-Based Apps - Prompt-based app development
• Integrations - Integration app development
• Chat Tools - Custom chat tools
• Audio Streaming - Raw audio processing
• Import - Data import APIs
• OAuth - OAuth integration
• Notifications - Push notifications
• Submitting - Submit apps to store

Hardware Documentation

• Omi Consumer - Consumer device information
• DevKit 2 - DevKit 2 information
• DevKit 1 - DevKit 1 information
• Omi Glass - Omi Glass information
• Painting OMI - Customization guide

Assembly Documentation

• Introduction - Assembly overview
• Buying Guide - What to buy
• Build the Device - Assembly instructions
• Flash Device - Firmware flashing

Information

• Support - Get help
• License - License information
• Disclaimer - Legal disclaimer
• Privacy - Privacy policy

External Documentation

• docs.omi.me - Complete online documentation
• API Reference - API endpoint reference

Related Files

• Architecture: .cursor/ARCHITECTURE.md
• API Reference: .cursor/API_REFERENCE.md
• Data Flow: .cursor/DATA_FLOW.md