Skip to main content

Overview

The Kaltura API documentation serves as a valuable resource for developers seeking to utilize Kaltura's Application Programming Interfaces (APIs). Within the Kaltura TV Platform (KTP), developers have access to two distinct sets of API technologies:

  1. Phoenix API: This API operates on standard HTTP POST/GET requests and responses. It empowers developers to perform operations such as adding, deleting, updating, and listing various platform resources and services. Typically, a POST request includes a JSON body containing the requested information (e.g., detailed filtering rules and parameters for a list operation on assets). On the other hand, a GET request encodes such information within the URL path. The server responds to POST/GET requests with the requested information in a JSON body.
  2. Kaltura Experience API (KEAPI): This API utilizes GraphQL as its foundation and leverages the Phoenix API as the underlying infrastructure. KEAPI enables efficient and flexible data retrieval by utilizing Phoenix API's inner resolvers to fetch the required information and format it according to the specifications outlined in the GraphQL query.

Both the Phoenix API and Kaltura Experience API (KEAPI) are complementary technologies. While Phoenix serves as the native interface for the KTP, KEAPI is built on top of it to enhance the client experience. With KEAPI, clients have the ability to precisely define the data they need, and the server responds with only the requested data. This approach eliminates the issues of over-fetching or under-fetching data, enabling clients to efficiently retrieve the required information with a single request.

The Kaltura API documentation portal offers comprehensive information to empower developers in mastering the utilization of these two API sets. It provides descriptions of each API, along with supplementary information that facilitates a understanding of best practices within the system. This supplementary information includes details about the system's data model and the main end-to-end API flows.