Kaltura API Overview
Building video experiences consists of ingesting media files, playing back videos, and reviewing usage and engagement analytics. In between, there is a world of nuances required for your unique use-case and application. Kaltura VPaaS is built on the principles of atomic services, SDKs, and tools that allow you full control and flexibility over every element and process in your media’s lifecycle.
Using the Kaltura API
The Kaltura REST API implements an HTTP POST/GET url-encoded requests structure. The API consist of service and actions for querying, setting, updating and listing entities as well as for configuring account settings, and for executing processes. Service and actions are grouped according to the entity type they are applied on, and provide all actions relevant to the specific entity.
This API documentation provides specific information on:
- Kaltura Services and their related actions
- Kaltura Objects and their related properties
- Kaltura Enumerated Types and their values
Note: A prerequisite for using Kaltura APIs is obtaining Kaltura account ID, aka the Partner ID (or pid). Register for a Kaltura VPaaS account.
If you're just starting out with Kaltura, we recommend reading: Getting Started with Kaltura VPaaS.
Being a REST API, the Kaltura API can be used by constructing and making calls to direct URLs as such http://www.kaltura.com/api_v3/index.php/service/The_Service_To_Use/action/The_Action_To_Execute.
Notice how the service and action are stated in the URL after each parameter name. Replace the placeholders above with the service name and action you'd like to execute:
- The_Service_To_Use — The service (entity in the system) to call. You can find the list of services in the API side panel under each of the categories (e.g. session, appToken, user, media, etc.)
- The_Action_To_Execute — The action you wish to execute on the service. You can find the list of actions available for each service in the API side panel under each of the services (e.g. session.start, session.end, etc.)
For example, to use the ping action to check if the API is up, you can use the
system service and
ping action: http://www.kaltura.com/api_v3/index.php/service/system/action/ping .
Note: Most services will require a proper Kaltura Session (KS) key; therefore, in addition to your call, you’ll also need to create a KS to be passed as a parameter in your request.
For example, to retrieve a list of media entries, you’ll need to call the list action on the media service, and provide a valid KS string. Therefore, the steps will be:
session.startproviding your account credentials.
- Pass the result of
session.startto the media.list API. E.g.: https://www.kaltura.com/api_v3/service/media/action/list/ks/Your_KS_String.
To learn more, follow these guides:
- How to Create a Kaltura Session
- Kaltura API Authentication and Security
- Introduction to Kaltura's Client Libraries
For reference, at each action page of the API docs you’ll see respected request GET URL at the top of the page.
For example, if you follow the guide for clipping and trimming, you’ll note that to trim an entry, the service you’ll need to use is called
media, and the action is called
updateContent. You’ll also notice that the input of this API action is expected to receive two parameters:
- The ID of the entry to replace with the newly trimmed entry
- A resource object representing the operations to execute on that entry
The resource is an object of type
KalturaOperationResource, and it in itself also expects to be filled with an object of
KalturaClipAttributes, which describes the operations to perform on the entry and the
KalturaEntryResourcethat describes the entry that carries out the operation.
Note: Kaltura does not recommend making direct calls via GET URLs without using a client library, since the API requires constructing objects for requests, requests can end up with complex URL structures that, if constructed manually, might result in semantic mistakes. Instead, Kaltura provides native client libraries for many programming languages that we recommend using in your applications instead of constructing direct URL calls.
We recommend you explore these tools as well:
- The Kaltura VPaaS Developer Guides.
- The Kaltura VPaaS Interactive Workflows, providing a quick way to learn about video workflows with Kaltura and see from real examples how to write application with Kaltura.
- The API Test Console, providing a quick exploration and discovery for each service and action, allowing you to try each action easily, and serving as code-example generator.
For support, please visit Kaltura Community Forums.