1. Introduction
Exercise-Engine Integration Documentation
Welcome to the Exercise-Engine Developer Documentation.
Exercise-Engine is an advanced digital fitness platform designed to analyze human movement in real-time. Utilizing state-of-the-art computer vision models (such as MediaPipe), our engine accurately tracks user exercises through their device's camera, provides real-time posture feedback, and ensures movements are performed correctly.
This documentation is created for Third-Party Developers who want to integrate our AI fitness capabilities into their own applications or websites without dealing with the underlying complexities of computer vision and biomechanical analysis.
1.1. Core Architecture: Platform vs. Portal
To integrate with our system, it is crucial to understand the two main components of the Exercise-Engine ecosystem. We use a Gateway/Redirect architecture (similar to payment gateways) to make integration as seamless as possible.
- 1The Platform (Management & API)
The Platform is your administrative hub. It consists of the backend services and APIs that you (the developer) will communicate with. You will use the Platform APIs to manage your users, generate authentication tokens, define custom exercises, and retrieve execution reports.
- 2The Portal (The Execution Engine)
The Portal is our dedicated, high-performance frontend application. It is the "beating heart" of the system where the actual workout happens. It handles camera access, real-time pose detection, multi-camera support, 3D animations, and immediate user feedback.
Note: You do not need to build a complex camera interface. You simply redirect your user to our Portal with a secure token. Once the user performs/creates/modifies their exercise, the Portal redirects them back to your application and sends the execution data via Webhooks.
1.2. The Integration Flow (High-Level)
Integrating Exercise-Engine into your system typically follows these four simple steps:
Configuration
Use the Platform APIs or website to set up the exercise or retrieve existing exercise configurations.
App Token Generation
Manually generate a secure App Token from the Platform Dashboard. For maximum security, root App Tokens cannot be generated via an API call; they act as your master key.
Redirection
Redirect your user's browser or web-view to the Portal URL, passing the generated token.
Callback & Webhook
Once finished, the Portal redirects the user back to your return URL and sends a Webhook payload to your backend.
1.3. Custom Exercise Media
We understand that every fitness program is unique. To ensure your users follow the exact form you intend, you can personalize the experience by providing your own training media.
Upload & Publish Your Own Media
You are not limited to our default library. You can upload your own custom videos or 3D animations for any exercise. This can be done either programmatically through our APIs or manually via the Platform GUI. Once published, these assets are seamlessly integrated into the Portal's instruction view.
Easy Retrieval
Managing your content is simple. Any custom media you upload can be retrieved later using the exercise's unique Exercise Key, allowing for efficient updates and cross-platform syncing.