Kaltura API Guides¶
Kaltura — The Agentic Digital Experience Platform. Kaltura is powering rich, agentic digital experiences across organizational journeys for customers, employees, learners, and audiences. The Kaltura platform combines intelligent content creation, enterprise-grade content management and intelligence, and multimodal conversational engagement capabilities. Kaltura serves leading enterprises, financial institutions, educational institutions, media and telecom providers, and other organizations worldwide.
These are comprehensive, live-tested API guides written for AI agents and developers building integrations on Kaltura.
Every guide uses curl examples with shell variables, follows a consistent structure, and has a companion test script that validates every documented endpoint against the live Kaltura API.
AI Agent Access¶
These guides are optimized for AI agent consumption through multiple discovery mechanisms:
| Method | How to Use |
|---|---|
| Agent Skill | Agents implementing agentskills.io auto-discover the Kaltura API skill with a capability map and links to each guide |
| Context7 | Add use context7 to your prompt — the guides are indexed and searchable via Context7 MCP |
| llms.txt | LLM-readable index at llms.txt following the llmstxt.org standard |
| Direct | Clone the repo or read any guide file directly — each is self-contained with curl examples |
Guides¶
| Guide | Description | Tests |
|---|---|---|
| API Getting Started | API structure, first call, multirequest batching, error handling | 13 tests |
| Session (KS) Guide | Kaltura Session generation and management | 13 tests |
| AppTokens API | Secure server-to-server auth without admin secrets | 17 tests |
| eSearch API | Unified search across entries, captions, metadata | 19 tests |
| Upload & Delivery API | Upload, chunked ingest, playback URLs, thumbnails | 34 tests |
| Player Embed Guide | Player v7 embed (iframe + JavaScript) | 14 tests |
| REACH API | Governed enrichment services marketplace: captions, translation, moderation, 22+ services | 35 tests |
| REACH — AI Clips | AI clip generation via Content Lab / REACH | 15 tests |
| Agents Manager API | Automated content processing agents | 15 tests |
| AI Genie API | Conversational AI search and RAG | 37 tests |
| Events Platform API | Virtual events, sessions, speakers, templates | 25 tests |
| App Registry API | Register and manage application instances | 20 tests |
| User Profile API | Per-app user profiles, event attendance lifecycle | 30 tests |
| Messaging API | Template-based email messaging, delivery tracking, unsubscribe management | 22 tests |
| Webhooks API | HTTP webhooks and email notifications on content events | 34 tests |
| Multi-Stream API | Dual/multi-screen video entries | 23 tests |
| User Management API | User CRUD, roles (RBAC), groups, login management | 25 tests |
| Auth Broker API | SSO/SAML auth profiles, app subscriptions, SPA proxy | 13 tests |
| Categories & Access Control API | Category hierarchy, membership, entitlement, access control profiles | 28 tests |
| Custom Metadata API | XSD schemas, metadata profiles, appinfo annotations, XSLT transforms | 24 tests |
| Captions & Transcripts API | Caption assets (SRT/VTT/DFXP), transcripts, multi-language, REACH | 36 tests |
| Analytics Reports API | Reports, CSV exports, live analytics, stream health | 35 tests |
| Analytics Events Collection API | Playback/engagement event collection, stats.collect, trackEvent | 16 tests |
| Gamification API | Leaderboards, badges, certificates, lead scoring, rules engine | 47 tests |
| Content Distribution API | Push content to YouTube, Facebook, FTP, cross-Kaltura via connectors | 84 tests |
| Syndication Feeds API | RSS/MRSS/iTunes/Roku feeds for external platforms to pull | 14 tests |
| Experience Components API | Index of all embeddable components with shared guidelines | 26 tests |
| Express Recorder API | Browser-based WebRTC video, audio, and screen recording | — |
| Captions Editor API | Interactive caption editing with video/waveform sync | — |
| Conversational Avatar Embed | AI-powered conversational video avatar embed | — |
| Chat & Collaborate (CnC) | Real-time chat, Q&A, polls alongside video content | — |
| Genie Widget API | Conversational AI search widget over video library | 7 tests |
| Media Manager API | Browsable media library: select, upload, manage entries | 11 tests |
| Content Lab API | AI content repurposing: summaries, chapters, clips, quizzes | 9 tests |
| Agents Widget API | Automated content-processing agent management UI | 7 tests |
| VOD Avatar Studio API | Pre-recorded avatar video creation: server-side API and widget embed | 22 tests |
| Embeddable Analytics API | Analytics dashboards via iframe + postMessage | — |
| Unisphere Framework API | Micro-frontend framework: loader, workspace, services | 21 tests |
| Multi-Account Management API | Sub-accounts, cross-account auth, multi-account analytics | 6 tests |
| Moderation API | Content flagging, approve/reject queue, AI moderation via REACH | 16 tests |
| Cue Points & Interactive Video API | Temporal metadata hub: base service, eSearch, protocols, bulk ops | 12 tests |
| Quiz API | Interactive video quizzes: questions, scoring, reports, IVQ plugin | 19 tests |
| Chapters & Slides API | Chapters, slides, timedThumbAsset workflow, navigation plugin | 8 tests |
| Annotations API | Annotations, threaded replies, hotspots, searchableOnEntry | 7 tests |
| Ad Cue Points API | VAST/VPAID ad insertion: pre-roll, mid-roll, overlay | 6 tests |
| Code, Event & Session Cue Points API | Code markers, view-change, forceStop, event/session cue points | 14 tests |
Quick Start¶
1. Get a Kaltura Account¶
Sign up at developer.kaltura.com or use an existing Kaltura account.
2. Configure Test Environment¶
3. Run Tests¶
# Run a specific test
python3 tests/test_upload_delivery_api.py
# Run all tests
cd tests
for f in test_*.py; do echo "=== $f ===" && python3 "$f" && echo "PASS" || echo "FAIL"; done
How These Guides Are Different¶
- Agent-first -- Written so an AI agent can read top-to-bottom and build integrations
- Language-agnostic -- All examples use
curlwith shell variables; adapt to any language - Live-tested -- Every guide has companion tests that run against the real Kaltura API
- Positive framing -- Guides document what works and how to use it, with no ambiguity
Project Structure¶
├── .agents/skills/kaltura-api/ # Agent Skill (agentskills.io)
├── KALTURA_*_API.md # API guides
├── KALTURA_*_GUIDE.md # Non-API documentation
├── AGENTS.md # AI agent project instructions
├── context7.json # Context7 indexing config
├── llms.txt # LLM-readable index
├── PLAN.md # Roadmap and full API landscape
└── tests/
├── .env.example # Template for API credentials
├── test_helpers.py # Shared test utilities
└── test_*_api.py # Per-guide test scripts
Contributing¶
Contributions are welcome! See CONTRIBUTING.md for guidelines.
Whether you want to: - Fix an error in an existing guide - Add a test for an undocumented edge case - Write a new guide for an uncovered Kaltura API - Improve clarity or add missing parameters
All contributions that improve accuracy and coverage are appreciated.
Roadmap¶
See PLAN.md for the full Kaltura API landscape and prioritized list of upcoming guides, including:
- Live Streaming
- Playlists
- Scheduling
- Cue Points & Interactive Video ✓ (hub + 5 dedicated type guides)
License¶
This project is licensed under the MIT License -- see LICENSE for details.