rPPG API Documentation

Welcome to the rPPG (Remote Photoplethysmography) API documentation. Extract vital signs from video using AI-powered contactless measurement.

Documentation

🚀 Quick Start

Get started in 5 minutes →

Install the SDK and analyze your first video.

---

🔐 Authentication

Learn about API keys →

Secure authentication with Bearer tokens.

---

📚 SDK Libraries

Complete SDK guide →

JavaScript/TypeScript SDK reference.

---

📘 API Reference

Full REST API docs →

Endpoint specifications and schemas.

---

💻 Code Examples

See practical examples →

React, Vue, Node.js, Python, and more.

---

🪝 Webhooks

Real-time notifications →

Event-driven updates (coming Q1 2026).

---

🧪 Testing & Sandbox

Test your integration →

Development mode and testing strategies.

---

⚡ Rate Limits

Understand limits →

60 requests/min, optimization tips.

Quick Example

import { RPPGClient } from 'rppg-api-client';

const client = new RPPGClient({
  apiKey: 'your-api-key',
  baseUrl: 'https://api.yourdomain.com/api'
});

// Analyze a video and get vital signs
const vitals = await client.analyzeVideo(videoFile);

console.log('Heart Rate:', vitals.heart_rate, 'bpm');
console.log('Respiratory Rate:', vitals.respiratory_rate, 'breaths/min');
console.log('HRV:', vitals.hrv);

What You'll Get

{
  "session_id": "sess_20251026_abc123",
  "heart_rate": 72.5,
  "respiratory_rate": 16.2,
  "hrv": 45.3,
  "confidence": 0.89,
  "timestamp": "2025-10-26T12:34:56Z",
  "processing_time_ms": 32450
}

Video Requirements

• ✅ Face clearly visible (frontal view)
• ✅ Good lighting
• ✅ 10-30 seconds duration
• ✅ Minimal movement
• ✅ Max 100MB file size

Installation

npm install rppg-api-client

Support

• Email: support@yourdomain.com
• GitHub: github.com/mediverusapi/rppg-model
• Documentation: You're here!

---

Ready to start? → Quick Start Guide