Skip to content

Introduction.mdx

Latest commit

 

History

History
273 lines (221 loc) · 9.43 KB

Introduction.mdx

File metadata and controls

273 lines (221 loc) · 9.43 KB
Raw
title Building Apps for Omi
icon grid-2
description 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.

What Are Omi Apps?

Omi apps are modular extensions that augment the core functionality of the Omi platform. They can modify AI behavior, analyze conversations, and connect with external services.

flowchart LR
    subgraph Device["📱 Omi Device"]
        Audio[Audio Stream]
    end

    subgraph Backend["🖥️ Omi Backend"]
        Trans[Transcription]
        Mem[Memory Creation]
        Chat[Chat System]
    end

    subgraph Apps["🧩 Your App"]
        RT[Real-time Webhook]
        MT[Memory Trigger]
        CT[Chat Tools]
        PP[Prompts]
    end

    Audio --> Trans
    Trans -->|Live transcript| RT
    Trans --> Mem
    Mem -->|On save| MT
    Chat -->|Tool calls| CT
    PP -->|Customize| Chat
Loading
Create custom AI personalities, alter conversation styles, or add specialized knowledge Process live transcripts as conversations happen Connect Omi to Slack, Notion, GitHub, and any external service Publish to the app store and monetize your creations

Prompt-Based Apps

Customize how Omi thinks and responds - no server required!

Alter Omi's conversational style and knowledge base. Create expert personas, custom assistants, or specialized advisors. 
**Example:** Make Omi communicate like a fitness coach or financial advisor
Customize how conversations are analyzed and summarized. Extract specific information based on your criteria. 
**Example:** Extract action items, key decisions, or meeting notes
Prompt-based apps are the easiest to create - just define your prompt and you're done!

Integration Apps

Connect Omi to external services with webhooks and APIs.

Run your code when a memory is created. Perfect for syncing to external tools. 
**Example:** Post conversation summaries to Slack or update a CRM
Process live audio transcripts as they happen. Enable real-time reactions. 
**Example:** Trigger smart home actions or live coaching feedback
Add custom tools that users can invoke in Omi chat. 
**Example:** "Send a message to #general in Slack" or "Create a GitHub issue"
Process raw audio bytes for custom STT, VAD, or audio analysis. 
**Example:** Custom speech recognition or audio feature extraction
Integration apps require a server endpoint (webhook) to receive data from Omi.

Quick Start: Build Your First App in 5 Minutes

Test the integration flow without writing any server code.

Go to [webhook.site](https://webhook.site) and copy your unique URL. 
<Frame>
  <img src="https://github.com/user-attachments/assets/083a6ec4-4694-4c7a-843a-4a1a0c254453" alt="Copy webhook URL" />
</Frame>
Get the app from the [App Store](https://apps.apple.com/us/app/friend-ai-wearable/id6502156163) or [Google Play](https://play.google.com/store/apps/details?id=com.friend.ios). In the Omi app: **Explore → Create an App** 
<Note>
If you don't see "Explore", go to Settings and select "Connect Device" first.
</Note>
1. Select a capability (e.g., "Real-time Transcript") 2. Paste your webhook.site URL 3. Install the app Start speaking - watch real-time data appear on webhook.site!

Example Apps

Learn from real apps built by the community.

Ask questions and get answers via notification in real-time. 
[View Source Code →](https://github.com/BasedHardware/omi/blob/main/plugins/notifications/hey_omi.py)
Proactive AI mentor that provides guidance during conversations. 
[View Source Code →](https://github.com/BasedHardware/omi/blob/main/plugins/basic/mentor.py)
Post conversation summaries and memories to Slack channels. 
[View Source Code →](https://github.com/BasedHardware/omi-slack-app)
Connect Omi to 5000+ apps through Zapier automations. 
[View Source Code →](https://github.com/BasedHardware/omi/tree/main/plugins/zapier)
Create issues and manage PRs from your conversations. 
[View Source Code →](https://github.com/aaravgarg/omi-github-app)
Integrate Omi with RingCentral communications. 
[View Source Code →](https://github.com/BasedHardware/omi-ringcentral-app)

Next Steps

Create apps that customize AI personality and memory processing - no server required Build webhooks for memory triggers and real-time transcript processing Add custom tools that users can invoke in Omi conversations Process raw audio bytes for custom STT or audio analysis Publish your app to the Omi app store

Video Tutorials

Learn how to build apps that trigger when Omi creates a new memory. 
<iframe
  width="560"
  height="315"
  src="https://www.youtube.com/embed/OOjWeGhuLeY?si=6Ya1GwqL4GSlq3mi"
  title="Memory Creation Triggers Tutorial"
  frameborder="0"
  allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
  referrerpolicy="strict-origin-when-cross-origin"
  allowfullscreen
></iframe>
Build apps that process live transcripts as conversations happen. 
<iframe
  width="560"
  height="315"
  src="https://www.youtube.com/embed/86D4v3n1o48?si=tQl-s9jikupjix0c"
  title="Real-time Transcript Processing Tutorial"
  frameborder="0"
  allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
  referrerpolicy="strict-origin-when-cross-origin"
  allowfullscreen
></iframe>
Set up a local development server without cloud deployment. 
<iframe
  width="560"
  height="315"
  src="https://www.youtube.com/embed/bMU6fTLysRY?si=3cvXEsWAUwKEnjHn"
  title="Running FastAPI Locally Tutorial"
  frameborder="0"
  allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
  referrerpolicy="strict-origin-when-cross-origin"
  allowfullscreen
></iframe>

Related Documentation

Add authentication flows to your integration apps Send push notifications to users from your app Create memories and trigger actions from external sources Understand how the chat system works under the hood