Integration apps allow OMI to interact with external services and process data in real-time. This guide will walk you through creating both Memory Creation Triggers and Real-Time Transcript Processors.
Running a FastAPI app locally, not on AWS:
These apps are activated when OMI creates a new memory, allowing you to process or store the memory data externally.
These apps process conversation transcripts as they occur, enabling real-time analysis and actions.
Decide whether you’re creating a Memory Creation Trigger or a Real-Time Transcript Processor, and outline its specific purpose.
Create an endpoint (webhook) that can receive and process the data sent by OMI. You can create a test webhook. The data structure will differ based on your app type:
Your endpoint will receive the entire memory object as a JSON payload, with a uid
as a query parameter. Here is what to
expect:
POST /your-endpoint?uid=user123
Your app should process this entire object and perform any necessary actions based on the full context of the memory.
Check the Notion CRM Python Example and it’s respective JSON format here.
For Real-Time Transcript Processors:
Your endpoint will receive a JSON payload containing the most recently transcribed segments, with both session_id and uid as query parameters. Here’s the structure:
POST /your-endpoint?session_id=abc123&uid=user123
Key points for Real-Time Transcript Processors:
Remember to handle errors gracefully and consider performance, especially for lengthy conversations!
Check the Realtime News checker Python Example and it’s respective JSON format here.
Time to put your app through its paces! Follow these steps to test both types of integrations:
Your endpoints are now ready to spring into action!
For Memory Creation Triggers, you can test with existing memories or wait for new ones to be created.
For Real-Time Processors, simply start a conversation with OMI to see your app in action.
Happy app crafting! We can’t wait to see what you create! 🎉
Submit your app using the Omi mobile app.
The webhook URL should be a POST request in which the memory object is sent as a JSON payload.
The setup completed URL is optional and should be a GET endpoint that returns {'is_setup_completed': boolean}
.
The auth URL is optional as well and is utilized by users to setup your app. The uid
query paramater will be appended to this URL upon usage.
The setup instructions can be either a link to instructions or text instructions for users on how to setup your app.
When writing your setup instructions, consider including:
Example structure:
Notes:
uid
query parameter to it, which you can use to
associate setup or credentials with specific users.