# Hypervideo - Transparent Video API

> Generate and play transparent videos, everywhere. Remove backgrounds from images and videos with one API call. Play them on any platform—including Safari and iOS—with cross-platform players.

## Base URL
https://api.hypervideo.dev

## Authentication
Bearer token required: `Authorization: Bearer YOUR_API_KEY`

## Endpoints

### POST /api/v1/image/remove-background
Remove background from image
Remove background using automatic edge color detection or manual chromakey.
Returns PNG with transparency.


### POST /api/v1/image/detect-background-color
Detect background color
Analyze image edges to detect the dominant background color

### POST /api/v1/video/remove-background
Remove video background
Remove background from video. Automatically selects the best processing method based on format.

**Smart Processing:**
- **WebP format**: Uses AI (BiRefNet) for 5x smaller files (~1.5MB vs 8MB)
- **We

### POST /api/v1/video/remove-background-video
Remove video background using AI video model (fastest)
Remove background from video using FAL Bria Video Background Removal.
Uses a single API call for the entire video - much faster than frame-by-frame!

**Processing Pipeline:**
1. Single API call to FAL

### POST /api/v1/video/remove-background-optimized
Remove video background with optimized WebP output
Remove background from video using chromakey with optimized WebP settings.
Combines the speed of chromakey with size optimizations (quality 60, resize, img2webp).

**Processing Pipeline:**
1. Auto-det

## SDKs & Players

- **@hypervideo-dev/sdk**: TypeScript SDK for Node.js and browsers
  npm install @hypervideo-dev/sdk

- **@hypervideo-dev/cli**: Command-line tool for video processing
  npm install -g @hypervideo-dev/cli

- **@hypervideo-dev/react**: WebGL player for transparent videos (React/Next.js)
  npm install @hypervideo-dev/react

- **@hypervideo-dev/expo**: Native Metal player for transparent videos (Expo/React Native, iOS)
  npm install @hypervideo-dev/expo

- **HypervideoVideo**: Swift Package for iOS/macOS with Metal rendering
  Swift Package Manager: https://github.com/hypersocialinc/hypervideo.git

## Links

- Docs: https://api.hypervideo.dev/docs
- OpenAPI: https://api.hypervideo.dev/docs.json
- Playground: https://app.hypervideo.dev