Skip to content

Kaltura API Guides — Map

This document organizes all guides around the Kaltura flywheel — the three pillars of the platform: Creation, Management, and Experiences. Use it to find the right guide, understand prerequisites, and navigate the knowledge base.

Flywheel Structure

Foundation — Start Here

Every integration begins with authentication. These guides are prerequisites for everything else.

Guide What You Learn
API Getting Started API structure, endpoints, first call, multirequest batching, error handling
Session Guide (KS) KS types, creation methods, privileges, validation, security
AppTokens Production auth without exposing secrets, HMAC, scoped tokens

Creation — Capturing, Editing & AI Enrichment

Guides for getting content into the platform and enriching it with AI.

Guide Subcategory What You Learn
Upload & Delivery Capturing & Ingestion Upload, transcode, thumbnails, chunked upload, delivery URLs
Multi-Stream Editing & Personalization Dual-screen / PIP multi-camera entries
Captions & Transcripts Editing & Personalization Caption asset CRUD, formats, serving, search
Custom Metadata Editing & Personalization XSD schemas, structured XML metadata on entries
Cue Points & Interactive Video Editing & Personalization Temporal metadata hub: base service, eSearch, protocols, bulk ops
Quiz API Editing & Personalization Interactive video quizzes: questions, scoring, reports, IVQ plugin
Chapters & Slides Editing & Personalization Chapters, slides, timedThumbAsset workflow, navigation plugin
Annotations Editing & Personalization Annotations, threaded replies, hotspots, searchableOnEntry
Ad Cue Points Editing & Personalization VAST/VPAID ad insertion: pre-roll, mid-roll, overlay
Code, Event & Session Cue Points Editing & Personalization Code markers, view-change, forceStop, event/session cue points
REACH API AI Enrichment Governed enrichment services marketplace: captions, translation, moderation, AI analysis, 22+ services
Agents Manager AI Enrichment Automated content-processing rules and workflows
AI Genie AI Enrichment Conversational AI / RAG over video library

Management — Organization, Intelligence & Orchestration

Guides for organizing content, managing users, controlling access, and connecting systems.

Guide Subcategory What You Learn
eSearch Content Management Full-text search across entries, captions, metadata
Categories & Access Control Content Management Content organization, entitlements, permissions
User Management Identity & Access User CRUD, roles, RBAC
Auth Broker (SSO) Identity & Access SAML/OIDC identity provider integration
Multi-Account Management Administration Sub-accounts, cross-account auth, aggregated analytics
Analytics Reports Intelligence Pull reports: content, engagement, cross-account
Analytics Events Collection Intelligence Push playback and engagement events
Moderation Content Management Content flagging, approve/reject queue, AI moderation via REACH
Webhooks Orchestration Real-time HTTP callbacks on content events
App Registry Orchestration Application instance registration and configuration
Messaging Orchestration Template-based email communications

Experiences — Playback, Events & Distribution

Guides for delivering content to end users through players, widgets, events, and syndication.

Guide Subcategory What You Learn
Player Embed Playback & Content Hubs Iframe/JS player embed, 30+ plugins, playback control
Experience Components Playback & Content Hubs Index of all embeddable components with shared guidelines
Express Recorder Playback & Content Hubs Browser-based WebRTC video/audio/screen recording
Captions Editor Playback & Content Hubs Interactive caption editing with video/waveform sync
Conversational Avatar Playback & Content Hubs AI-powered conversational video avatar embed
Chat & Collaborate Playback & Content Hubs Real-time chat, Q&A, polls alongside video
Genie Widget Playback & Content Hubs Conversational AI search widget over video library
Media Manager Playback & Content Hubs Browsable media library: select, upload, manage entries
Content Lab Playback & Content Hubs AI content repurposing: summaries, chapters, clips, quizzes
Agents Widget Playback & Content Hubs Automated content-processing agent management UI
VOD Avatar Studio Playback & Content Hubs Pre-recorded avatar video creation: server-side API (CRUD, AI composition, generation) and Unisphere widget embed
Embeddable Analytics Playback & Content Hubs Analytics dashboards via iframe + postMessage
Unisphere Framework Playback & Content Hubs Micro-frontend framework: loader, workspace, services
Events Platform Virtual Events & Webinars Virtual events, webinars, town halls, sessions
User Profile Virtual Events & Webinars Per-app user profiles, event attendance tracking
Gamification Virtual Events & Webinars Leaderboards, badges, certificates
Content Distribution Distribution & Syndication Push to YouTube, Facebook, FTP, custom connectors
Syndication Feeds Distribution & Syndication RSS/MRSS/Podcast/Roku XML feeds

Dependency Graph

graph TD
    %% Foundation
    GS["API Getting Started"]
    KS["Session Guide"]
    AT["AppTokens"]

    GS --> KS --> AT

    %% Creation
    UD["Upload & Delivery"]
    MS["Multi-Stream"]
    CT["Captions & Transcripts"]
    CM["Custom Metadata"]
    RE["REACH API"]
    AG["Agents Manager"]
    AI["AI Genie"]

    KS --> UD
    UD --> MS
    KS --> CT
    KS --> CM
    KS --> RE
    RE --> AG
    RE --> CT
    KS --> AI
    CP["Cue Points Hub"]
    QZ["Quiz"]
    CS["Chapters & Slides"]
    AN["Annotations"]
    AD["Ad Cue Points"]
    CE["Code/Event/Session CPs"]
    KS --> CP
    UD --> CP
    CP --> QZ
    CP --> CS
    CP --> AN
    CP --> AD
    CP --> CE

    %% Management
    ES["eSearch"]
    CA["Categories & Access Control"]
    UM["User Management"]
    AB["Auth Broker SSO"]
    MA["Multi-Account Management"]
    AR["Analytics Reports"]
    AE["Analytics Events"]
    WH["Webhooks"]
    APR["App Registry"]
    MSG["Messaging"]

    KS --> ES
    KS --> CA
    KS --> UM
    AT --> AB
    KS --> MA
    AR --> MA
    KS --> AR
    MO["Moderation"]
    KS --> MO
    RE --> MO
    KS --> WH
    KS --> APR
    KS --> MSG

    %% Experiences
    PE["Player Embed"]
    EC["Experience Components"]
    ER["Express Recorder"]
    CE["Captions Editor"]
    CVA["Conv. Avatar"]
    CNC["Chat & Collab"]
    GW["Genie Widget"]
    EA["Embed Analytics"]
    UF["Unisphere Framework"]
    MM["Media Manager"]
    CL["Content Lab"]
    AW["Agents Widget"]
    VA["VOD Avatar Studio"]
    EP["Events Platform"]
    UP["User Profile"]
    GA["Gamification"]
    DI["Distribution"]
    SY["Syndication"]

    KS --> PE
    PE --> AE
    KS --> EC
    EC --> ER
    EC --> CE
    EC --> CVA
    EC --> CNC
    EC --> GW
    EC --> EA
    EC --> UF
    EC --> MM
    EC --> CL
    EC --> AW
    EC --> VA
    UF --> GW
    UF --> MM
    UF --> CL
    UF --> AW
    UF --> VA
    AG --> AW
    RE --> CL
    KS --> EP
    APR --> UP
    EP --> GA
    KS --> DI
    KS --> SY

    %% Cross-links
    CT --> EC
    ES --> AI

    %% Styling
    classDef foundation fill:#4A90D9,color:#fff,stroke:#2C5F8A
    classDef creation fill:#7B68EE,color:#fff,stroke:#5B48CE
    classDef management fill:#F5A623,color:#fff,stroke:#C5861A
    classDef experience fill:#50C878,color:#fff,stroke:#3A9A5A

    class GS,KS,AT foundation
    class UD,MS,CT,CM,RE,AG,AI,CP,QZ,CS,AN,AD,CE creation
    class ES,CA,UM,AB,MA,AR,AE,WH,APR,MSG,MO management
    class PE,EC,ER,CE,CVA,CNC,GW,EA,UF,MM,CL,AW,VA,EP,UP,GA,DI,SY experience

Legend:
Blue = Foundation | Purple = Creation | Orange = Management | Green = Experiences

Decision Tree

"I want to..."

Goal Start With
Make my first API call API Getting Started
Authenticate securely in production AppTokens
Upload and transcode video Upload & Delivery
Embed a video player Player Embed
Search my content library eSearch
Add captions or transcripts Captions & Transcripts
Enrich content with AI (captions, translation, moderation, and more) REACH API
Build a chatbot over video AI Genie
Embed Genie AI search widget Genie Widget
Embed composable experiences (multi-runtime) Unisphere Framework
Embed a media library or picker Media Manager
Repurpose video with AI (summaries, chapters, clips) Content Lab
Automate content processing (captions, translation on upload) Agents Widget or Agents Manager API
Generate avatar videos from scripts VOD Avatar Studio
Record from browser Express Recorder
Embed a real-time conversational AI avatar Conversational Avatar
Embed analytics dashboards Embeddable Analytics
Edit captions visually Captions Editor
Create a virtual event Events Platform
Send email notifications Messaging
Get analytics data Analytics Reports
Distribute to YouTube/Roku Distribution or Syndication
Manage sub-accounts Multi-Account Management
React to content events Webhooks
Set up SSO/SAML Auth Broker
Add custom fields to entries Custom Metadata
Control who sees what Categories & Access Control
Moderate content (flag, approve, reject) Moderation
Screen content with AI for policy violations Moderation
Add chapters to video Chapters & Slides
Add annotations or hotspots to video Annotations
Insert ads (VAST/VPAID) at specific times Ad Cue Points
Build interactive video quizzes Quiz
Sync slides with video playback Chapters & Slides
Add code markers or view-change commands Code, Event & Session CPs
Understand cue point types and base service Cue Points Hub
Generate thumbnails Upload & Delivery (section 6)
Add gamification Gamification