Skip to main content

Overview

The Omi Developer API provides programmatic access to your personal Omi data, allowing you to build custom applications and integrations. Use it to create analytics dashboards, export data to other services, build automation workflows, or contribute data back to your Omi account.

Memories

Read & write user memories

Conversations

Access full transcripts

Folders

List conversation folders

Action Items

Manage tasks & to-dos

API Keys

Manage API access

Quick Start

Get Your API Key

Open the Omi app and navigate to Settings → Developer → Create Key
Copy the key immediately - you won’t be able to see it again!

Make Your First Request

Explore the Endpoints

Check out the endpoint pages for detailed documentation on each resource.

Base URL

For self-hosted instances, replace with your backend URL.

Endpoints at a Glance

Memories


Authentication

All API requests require your Developer API key in the Authorization header:
MCP keys (omi_mcp_...) only authenticate MCP clients against /v1/mcp/sse. They do not authenticate REST Developer API calls. For memories, conversations, folders, and action items over HTTP, create a Developer API key (omi_dev_...) and call endpoints under /v1/dev/user/... such as /v1/dev/user/memories. Never commit API keys to version control or share them publicly.

Rate Limits

Rate limit headers are included in responses:

Error Responses

HTTP Status Codes


Security Best Practices

Store Keys Securely

Use environment variables or secret management services

Rotate Keys Regularly

Generate new keys and revoke old ones periodically

Use Specific Keys

Create separate keys for different applications

Monitor Usage

Check the “last used” timestamp in your key list
If a key is compromised, revoke it immediately from Settings → Developer in the Omi app.

Developer API vs MCP

If you see 404 Not Found for legacy memory paths such as /v1/memories or /v2/memories, use the Developer API path /v1/dev/user/memories instead. If you see 401 Unauthorized while using an omi_mcp_... key, create and use an omi_dev_... key for REST API requests.

Use Developer API when you need

  • Programmatic access for custom applications
  • Batch operations (multiple memories/action items)
  • Integration with external services
  • Custom automation workflows

Use MCP when you want

  • AI assistants like Claude to interact with your data
  • Natural language queries and AI-powered insights
  • Context-aware AI assistance
Learn more about the Model Context Protocol in the MCP documentation.

Other APIs

Looking for different API capabilities? Omi offers several APIs for different use cases:

Integration Import APIs

For App Developers - Create conversations and memories on behalf of users who have enabled your app

Webhook Triggers

For App Developers - Receive real-time notifications when memories are created or transcripts are processed

Chat Tools

For App Developers - Add custom tools that Omi’s AI can invoke during conversations

Audio Streaming

For App Developers - Process raw audio bytes in real-time via WebSocket
The Developer API (this section) is for accessing your own personal data. The APIs above are for building apps that interact with other users’ data (with their permission).