Reference Documentation

Welcome to the RIXL Reference Documentation — your comprehensive technical resource for APIs, SDKs, and platform specifications. Whether you're implementing REST endpoints, configuring React components, or understanding platform limits, find everything you need here.

Quick Actions

REST API Reference

Complete API documentation with live examples and response schemas.

React SDK Components

Video and Image component props and implementation guides. Feed component available.

Interactive API Docs

Test API endpoints directly in your browser with live data. (Coming Soon)

API Documentation

Core Endpoints

Video API

Upload, process, and manage video content with quality tier selection and HLS streaming.

Image API

Upload and deliver images with AVIF compression and responsive delivery.

Feed API

Retrieve dynamic content feeds with creator filtering and pagination.

Authentication & Security

API Keys

Project-based authentication with secure key management and rotation.

Rate Limiting

Request limits, burst handling, and quota management across subscription tiers.

Error Handling

Comprehensive error codes, messages, and troubleshooting guides.

React SDK Reference

Component Library

Video Component

HLS video player with progress tracking, quality controls, and fullscreen support.

Image Component

Delivered images with AVIF compression, lazy loading, and responsive sizing.

Feed Component

Dynamic content feeds with infinite scroll and real-time updates. (Coming Soon)

Hooks & Utilities

useProgressBar

Track video playback progress and duration with real-time updates.

TypeScript Support

Full TypeScript definitions for all components and hooks.

Browser Compatibility

Chrome 88+, Firefox 85+, Safari 14+, Edge 88+ support.

Platform Specifications

Media Processing

Video Formats

MP4, MOV, AVI, WebM, MKV input. HLS output with adaptive streaming.

Image Formats

JPEG, PNG, WebP, HEIC input. AVIF output with fallbacks.

Quality Tiers

Basic (720p), Shorts (1080p), Pro (4K) with different processing speeds.

Platform Limits

File Size Limits

Videos: 2GB max | Images: 100MB max | No quantity limits.

API Rate Limits

1000 requests/minute per key | Burst handling included.

Processing Times

Basic: ~1x | Shorts: ~1.5x | Pro: ~2-3x video length.

API Quick Reference

Core Endpoints

Endpoint	Method	Description
`/videos/upload/init`	POST	Initialize video upload
`/videos`	GET	List videos with pagination
`/videos/{id}`	GET	Get video details and status
`/videos/{id}`	DELETE	Delete video and assets
`/videos/{id}/thumbnail`	GET	Get video thumbnail

Authentication: X-API-Key: YOUR_PROJECT_API_KEY

Endpoint	Method	Description
`/images/upload/init`	POST	Initialize image upload
`/images/upload/complete`	POST	Complete image upload
`/images`	GET	List images with pagination
`/images/{id}`	GET	Get image details
`/images/{id}`	DELETE	Delete image

Authentication: X-API-Key: YOUR_PROJECT_API_KEY

Endpoint	Method	Description
`/feeds/{id}`	GET	Get feed content with optional creator filtering

Authentication: X-API-Key: YOUR_PROJECT_API_KEY

Query Parameters:

creator_id (optional): Filter feed content by specific creator
limit (optional): Number of items to return (default: 10, max: 100)
offset (optional): Pagination offset (default: 0)

Response Format

All API responses follow a consistent JSON structure:

{
  "status": "success",
  "data": { /* response data */ },
  "message": "Operation completed successfully",
  "pagination": { /* pagination info for list endpoints */ }
}

HTTP Status Codes

Code	Status	Description	Action
200	OK	Request successful	Continue
201	Created	Resource created	Use returned ID
400	Bad Request	Invalid parameters	Check request format
401	Unauthorized	Invalid API key	Verify authentication
403	Forbidden	Insufficient permissions	Check project access
404	Not Found	Resource doesn't exist	Verify resource ID
429	Too Many Requests	Rate limit exceeded	Implement backoff
500	Internal Server Error	Server error	Retry or contact support

Common Request Parameters

Parameter	Type	Required	Description	Example
`file_name`	string	Yes	Original filename	`"video.mp4"`
`video_quality`	string	No	Processing tier	`"basic"`, `"shorts"`, `"pro"`
`image_format`	string	No	Thumbnail format	`"jpg"`, `"png"`, `"webp"`
`limit`	integer	No	Items per page (max 100)	`25`
`offset`	integer	No	Pagination offset	`0`

React SDK Component Reference

Video Component Props

type VideoTheme = "default" | "minimal" | "hideUI";

interface VideoProps extends HTMLProps<HTMLVideoElement> {
  id?: string;                   // Optional: Video ID from RIXL
  progressBar?: boolean;         // Show progress bar
  allowPlayPause?: boolean;      // Allow play/pause controls
  allowFullscreen?: boolean;     // Enable fullscreen mode
  allowPictureInPicture?: boolean; // Enable picture-in-picture
  volume?: number;               // Volume level (0-1)
  theme?: VideoTheme;            // UI theme: "default" | "minimal" | "hideUI"
  // Inherits all standard HTML video props: autoplay, muted, loop, controls, poster, onPlay, onPause, onEnded, etc.
}

Image Component Props

interface ImageProps extends HTMLProps<HTMLImageElement> {
  id?: string;                   // Optional: Image ID from RIXL
  // Inherits all standard HTML image props: alt, className, loading, sizes, onLoad, onError, etc.
}

Feed Component Props

interface FeedProps extends HTMLProps<HTMLDivElement> {
  feedId: string;               // Required: Feed ID from RIXL
  creatorId: string;            // Required: Creator ID to filter content
  startPostId?: string;         // Optional: Starting post ID for pagination
}

Technical Specifications

Browser Requirements

Browser	Minimum Version	Features Supported
Chrome	88+	Full HLS, AVIF, WebP
Firefox	85+	Full HLS, WebP (AVIF fallback)
Safari	14+	Full HLS, HEIC, WebP
Edge	88+	Full HLS, AVIF, WebP
Mobile Safari	14+	Full HLS, HEIC support
Chrome Mobile	88+	Full HLS, AVIF support