Introduction

Welcome to the Emogg API documentation. Emogg provides a sophisticated service for analyzing emotions in people, either through live streams or pre-recorded videos. Our technology captures and interprets emotional data in real-time, offering valuable insights for a variety of applications. To cater to different needs and integration scenarios, Emogg offers two types of APIs: REST API and WebSocket API. Each API serves distinct purposes and is designed to accommodate specific use cases for our clients.

REST API

The REST API operates over HTTPS, ensuring secure communication and data transfer. It is designed for clients looking to perform administrative actions such as manage their sessions, retrieve historical emotional analysis data, create new sessions etc. This API is particularly suitable for scenarios where immediate, real-time data is not critical but accessing comprehensive historical data and performing administrative actions is essential

WebSocket API

Our WebSocket API, secured through the WSS protocol, is tailored for real-time communication and data delivery. This API is ideal for clients who require instant access to emotional analysis data as it unfolds during live sessions. For use cases like monitoring or real-time audience engagement analysis, this API provides a seamless, low-latency connection to our emotion analysis engine. This ensures that clients receive immediate updates and can react or make decisions in real-time based on the emotional data provided.

Both APIs are designed to be flexible and comprehensive, ensuring that whether you need instantaneous data during live events or detailed analytics and session management capabilities, Emogg has you covered. Read on to find out more about each API's capabilities, how to get started, and how to make the most of Emogg's emotion analysis service.