# Docs ## Docs - [Create Action Item](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/action-items/create-action-item.md): Create a new action item for the authenticated user. - [Create Action Items Batch](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/action-items/create-action-items-batch.md): Create multiple action items in a batch. - [Delete Action Item](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/action-items/delete-action-item.md): Delete an action item by ID. - [Get Action Items](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/action-items/get-action-items.md): Get action items with optional filters. Locked action items are excluded. - [Update Action Item](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/action-items/update-action-item.md): Update an action item. - [Create Key](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/api-keys/create-key.md): Create a new Developer API key with optional scopes. - [Delete Key](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/api-keys/delete-key.md) - [Get Keys](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/api-keys/get-keys.md) - [Create Conversation](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/conversations/create-conversation.md): Create a new conversation from text for the authenticated user. - [Create Conversation From Segments](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/conversations/create-conversation-from-segments.md): Create a new conversation from structured transcript segments. - [Delete Conversation Endpoint](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/conversations/delete-conversation-endpoint.md): Delete a conversation by ID. - [Get Conversation Endpoint](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/conversations/get-conversation-endpoint.md): Get a single conversation by ID. - [Get Conversations](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/conversations/get-conversations.md): Get conversations with optional transcript inclusion. - [Update Conversation Endpoint](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/conversations/update-conversation-endpoint.md): Update a conversation's title or discard status. - [Search Memories Vector](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/developer/search-memories-vector.md): Search developer-readable default memory memory through hydrated vector candidates. - [Create Action Item](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/endpoint/action-items/create.md): Create a new action item for the authenticated user. - [Create Action Items (Batch)](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/endpoint/action-items/create-batch.md): Create multiple action items in a batch. - [Delete Action Item](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/endpoint/action-items/delete.md): Delete an action item by ID. - [List Action Items](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/endpoint/action-items/list.md): Get action items with optional filters. Locked action items are excluded. - [Update Action Item](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/endpoint/action-items/update.md): Update an action item. - [Create Conversation](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/endpoint/conversations/create.md): Create a new conversation from text for the authenticated user. - [Create from Transcript Segments](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/endpoint/conversations/create-from-segments.md): Create a new conversation from structured transcript segments. - [Delete Conversation](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/endpoint/conversations/delete.md): Delete a conversation by ID. - [Get Conversation](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/endpoint/conversations/get.md): Get a single conversation by ID. - [List Conversations](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/endpoint/conversations/list.md): Get conversations with optional transcript inclusion. - [Update Conversation](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/endpoint/conversations/update.md): Update a conversation's title or discard status. - [List Folders](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/endpoint/folders/list.md): Get all folders for the authenticated user. - [Create API Key](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/endpoint/keys/create.md): Create a new Developer API key with optional scopes. - [List API Keys](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/endpoint/keys/list.md) - [Revoke API Key](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/endpoint/keys/revoke.md) - [Create Memory](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/endpoint/memories/create.md): Create a new memory for the authenticated user. - [Create Memories (Batch)](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/endpoint/memories/create-batch.md): Create multiple memories in a batch. - [Delete Memory](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/endpoint/memories/delete.md): Delete a memory by ID. - [List Memories](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/endpoint/memories/list.md) - [Update Memory](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/endpoint/memories/update.md): Update a memory's content, visibility, tags, or category. - [Get User Folders](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/folders/get-user-folders.md): Get all folders for the authenticated user. - [Create Goal](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/goals/create-goal.md): Create a durable goal. Metrics are optional and other goals are never changed implicitly. - [Delete Goal](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/goals/delete-goal.md): Delete a goal by ID. - [Get Goal](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/goals/get-goal.md): Get a single goal by ID. - [Get Goal History](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/goals/get-goal-history.md): Get progress history for a goal. - [Get Goals](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/goals/get-goals.md): Get user goals. - [Update Goal](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/goals/update-goal.md): Update a goal. - [Update Goal Progress](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/goals/update-goal-progress.md): Update the progress value of a goal. - [API Reference](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/introduction.md): Complete reference for the Omi Developer API. Build integrations with memories, conversations, action items, and more. - [Create Memories Batch](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/memories/create-memories-batch.md): Create multiple memories in a batch. - [Create Memory](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/memories/create-memory.md): Create a new memory for the authenticated user. - [Delete Memory](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/memories/delete-memory.md): Delete a memory by ID. - [Get Memories](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/memories/get-memories.md) - [Update Memory](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/memories/update-memory.md): Update a memory's content, visibility, tags, or category. - [Building the Device](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/assembly/Build_the_device.md): Step-by-step guide to assemble your own Omi device from parts. - [Parts List](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/assembly/Buying_Guide.md): Everything you need to build your own Omi device. Availability and prices may vary by region. - [Build Your Own Omi Device](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/assembly/introduction.md): As an open-source community, we empower enthusiasts to create their own Omi devices. This guide focuses on building the DevKit 1, as later versions use custom PCBs not suited for DIY assembly. - [App Setup](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/AppSetup.md): Set up the Omi Flutter app for development. Build automatically with our dev backend, or manually with your own. - [Real-Time Audio Streaming](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/AudioStreaming.md): Stream audio bytes from your Omi device to any backend service in real time. - [Contribution Guide](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/Contribution.md): Contribute to Omi and earn rewards! Some tasks have paid bounties. - [Cursor Configuration (.cursor)](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/Cursor.md): How Omi uses the .cursor folder (rules, skills, commands, and agents) to guide AI assistance in this repository. - [DevKit 2 Testing](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/DevKit2Testing.md): Test storage, button, and SD card functionality on the Omi DevKit 2. - [App-Device Protocol](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/Protocol.md): BLE protocol specification for communicating with Omi wearable devices - [Agent control plane](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/agent-control-plane.md) - [Agent control plane invariants](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/agent-control-plane-invariants.md) - [Action Items](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/api/action-items.md): Create and retrieve action items (tasks/to-dos) via the Developer API - [Conversations](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/api/conversations.md): Create and retrieve conversations via the Developer API - [Folders](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/api/folders.md): Retrieve user-defined folders for organizing conversations via the Developer API - [API Keys](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/api/keys.md): Manage your Developer API keys - [Memories](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/api/memories.md): Create and retrieve memories via the Developer API - [Quick Start](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/api/overview.md): Access your Omi data programmatically with the Developer API. Build custom integrations, analytics dashboards, and automation workflows using your memories, conversations, and action items. - [Real-Time Audio Streaming](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/apps/AudioStreaming.md): Stream raw audio bytes from your Omi device to any backend for custom speech processing, VAD, or audio analysis. - [Chat Tools](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/apps/ChatTools.md): Add custom chat tools to your Omi app that extend Omi's capabilities in user conversations. - [Data Import APIs](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/apps/Import.md): Programmatically create and read conversations and memories in users' Omi accounts using the Integration Import APIs. - [Integration Apps](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/apps/Integrations.md): Build webhook-based apps that connect Omi to external services. Process memories, real-time transcripts, raw audio, or daily summaries. - [Building Apps for Omi](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/apps/Introduction.md): Create apps that extend Omi's capabilities - from custom AI personalities to real-time integrations. Publish to the app store and earn from your creations. - [Sending Notifications](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/apps/Notifications.md): Send push notifications to Omi users from your apps - both direct text notifications and AI-generated proactive notifications. - [OAuth Authentication](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/apps/Oauth.md): Integrate your application with Omi using OAuth 2.0 to securely access user data with explicit consent. - [Open Source Your App](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/apps/OpenSource.md): Contribute your Omi app to the open-source repo. Share your code with the community, get visibility, and help other developers learn from your work. - [Prompt-Based Apps](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/apps/PromptBased.md): Customize Omi's behavior with prompts - no server required. Create specialized AI personalities and memory processors. - [Publish Your App](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/apps/Submitting.md): Submit your app to the Omi app store. Learn the review process, guidelines, and best practices for a successful submission. - [GitHub](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/apps/examples/Github.md): Create GitHub issues using voice commands through your OMI device - [Omi Mentor](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/apps/examples/OmiMentor.md): Get personalized AI mentorship during your conversations with OMI - [Slack](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/apps/examples/Slack.md): Send Slack messages using voice commands through your OMI device - [Backend Setup](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/backend/Backend_Setup.md): Set up the Omi backend infrastructure for local development. This guide covers Google Cloud, Firebase, OAuth, and all required services. - [Storing Conversations & Memories](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/backend/StoringConversations.md): This document outlines how Omi stores conversation data and extracts memories from conversations. - [Backend Deep Dive](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/backend/backend_deepdive.md): Welcome to the Omi backend! This document provides a comprehensive overview of Omi's architecture and code, guiding you through its key components, functionalities, and how it all works together to power a unique and intelligent AI assistant experience. - [Chat System Architecture](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/backend/chat_system.md): A comprehensive technical deep dive into how Omi's intelligent chat system processes questions, routes them through LangGraph, calls tools, and generates contextual responses. - [Goal and thread lifecycle](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/backend/goal_workstream_lifecycle.md): Canonical goal focus, workstream journals, artifact versions, and relationship rules. - [LLM Gateway](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/backend/llm_gateway.md): Architecture for Omi's internal LLM routing gateway, auto lanes, route artifacts, and chat-structured workloads. - [Prod Backend Deploy and Hotfix Runbook](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/backend/prod_hotfix_runbook.md): Safe workflow for prod backend Cloud Run deploys, traffic repair, and Cloud Run-only hotfixes. - [Task and Candidate lifecycle](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/backend/task_candidate_lifecycle.md): Canonical backend contracts, resolution rules, and rollout compatibility for smart tasks. - [Real-time Transcription](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/backend/transcription.md): A comprehensive guide to Omi's real-time audio transcription system, covering WebSocket connections, STT providers, speaker diarization, message formats, and building external custom STT services. - [For agents](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/cli/agents.md): Stable agent contract — JSON output, exit codes, retry semantics. - [Command reference](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/cli/commands.md): Every verb, every flag. - [Install](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/cli/install.md): Install omi-cli and confirm the binary is on your PATH. - [Introduction](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/cli/introduction.md): Talk to Omi from your terminal. Designed for humans and agents alike. - [Quickstart](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/cli/quickstart.md): Get from zero to your data — pick browser OAuth or paste a dev API key. - [Troubleshooting](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/cli/troubleshooting.md): Common failure modes and how to fix them. - [Desktop voice-turn architecture](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/desktop-voice-turns.md): Ownership, lifecycle, deadlines, and testing for macOS push-to-talk turns - [Compile Firmware](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/firmware/Compile_firmware.md): Build and flash custom firmware for your Omi device using nRF Connect. - [Examples](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/mcp/examples.md): Example prompts and integrations with the Omi MCP server - [Introduction](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/mcp/introduction.md): Connect AI assistants to your Omi data using the Model Context Protocol - [Setup](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/mcp/setup.md): Connect your AI assistant to the Omi MCP server - [Tools Reference](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/mcp/tools.md): Complete reference for all Omi MCP tools - [Troubleshooting](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/mcp/troubleshooting.md): Debug and fix common MCP connection issues - [Cloud Audio Storage](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/savingaudio.md): Set up Google Cloud Storage for saving audio files from your Omi device. - [React Native SDK](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/sdk/ReactNative.md): Cross-platform mobile SDK for connecting to Omi devices via Bluetooth Low Energy - [Python SDK](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/sdk/python.md): Connect to Omi devices over Bluetooth, decode Opus audio, and transcribe in real-time using Deepgram - [SDK Overview](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/sdk/sdk.md): Build on top of Omi with official SDKs for Python, Swift, and React Native - [Swift SDK](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/developer/sdk/swift.md): Native iOS/macOS SDK for connecting to Omi devices with local Whisper transcription - [Update Omi Firmware](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/get_started/Flash_device.md): Keep your Omi device up to date with the latest firmware. Use the app for easy updates or follow the manual process. - [Chat Tips & Best Practices](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/get_started/chat_tips.md): Learn how to get the best results from Omi chat. Discover prompting strategies, example questions, and tips based on how the system works internally. - [Introduction](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/get_started/introduction.md): Welcome to Omi - the world's most advanced open-source AI wearable - [Omi DevKit 1](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/hardware/DevKit1.md): DevKit 1 is a necklace form factor device that can be worn around the neck. It runs on Xiao nRF52840, is powered by a rechargeable battery, and connects to your phone to stream the audio data. - [Omi DevKit 2](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/hardware/DevKit2.md): DevKit 2 builds on DevKit 1 with 8GB onboard storage, a speaker, and a programmable button. This enables standalone recording mode while maintaining the necklace form factor. - [Omi](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/hardware/OmiConsumer.md): The Omi Consumer Version 1 (CV1) is the latest hardware, built for everyday use. Powered by a dual-core nRF5340 SoC with Wi-Fi 6 and dual microphones for high-quality audio capture. - [Painting OMI device](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/hardware/PaintingOMI.md): A comprehensive guide on how to paint your OMI device for a custom look. - [Assembly & BOM](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/hardware/consumer/assembly.md): Bill of Materials and assembly reference for building the Omi from components. - [Electronics](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/hardware/consumer/electronics.md): PCB design files for the Omi mainboard, charger board, and flexible PCB — Altium source, Gerber files, and schematics. - [Open Source Hardware](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/hardware/consumer/index.md): Complete open-source design files for the Omi Consumer — PCB schematics, Gerbers, mechanical STEP files, BOM, and assembly guides. - [License](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/hardware/consumer/license.md): The Omi hardware design files are released under the MIT license. - [Mechanical & Packaging](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/hardware/consumer/mechanical.md): STEP files for the Omi enclosure, charger dock, and retail packaging — organized by manufacturing process. - [Hardware & Assembly](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/hardware/omiGlass.md): Open source smart glasses with 6x the battery life of Meta Ray-Bans. Build your own AI-powered glasses with the XIAO ESP32 S3 Sense. - [Flash Firmware](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/hardware/omiglass/flash-firmware.md): Flash the latest OmiGlass firmware using PlatformIO - [Disclaimer](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/info/Disclaimer.md): Important information about using Omi devices and software. - [License](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/info/License.md): Omi is open source software available under the MIT License. - [Privacy Policy](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/info/Privacy.md): At Omi, your privacy and the security of your data are our top priorities. This Privacy Policy explains how we collect, use, and protect your information. - [Support](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/info/Support.md): Get help with Omi through our community channels or contact us directly for commercial inquiries. - [Integrate 3P Wearables](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/doc/integrations.md): A guide to integrating any wearable device, like Plaud, Limitless, or your own custom hardware, with the Omi open-source ecosystem. - [Get Started with Omi](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/getstartedwithomi.md): Choose your device and get started with Omi ## OpenAPI Specs - [openapi](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/openapi.json) - [integration-public-openapi](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/integration-public-openapi.json) - [app-client-openapi](https://omi-codex-issue-9443-memory-v3-package.mintlify.app/api-reference/app-client-openapi.json)