Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kaltura asset API

The asset API from Kaltura — 9 operation(s) for asset.

Kaltura asset API is one of 222 APIs that Kaltura publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include asset. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a getting-started guide.

This API exposes 9 operations across 9 paths, and defines 94 schemas. It is described by OpenAPI 2.0, at version 3.6.287.20720.

Requests are made against the base URL https://www.kaltura.com/api_v3.

9 operations 9 paths 94 schemas 9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
3.6.287.20720
Base URL
https://www.kaltura.com/api_v3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Kaltura asset API declares 1 security scheme for authenticating requests. An API key is passed in the body as ks (ks). By default, every request must be authenticated.

  • ks — A Kaltura session ID

Paths & Operations 9

Across 9 paths, the API surfaces 9 operations — 9 POST. Each is listed below with its method, path, parameters, and response codes.

asset 9
POST
/service/asset/action/add
Add a new asset
asset.add 1 param → 200x-Errors
POST
/service/asset/action/count
Returns a group-by result for media or EPG according to given filter. Lists values of each field and their respective count.
asset.count 1 param → 200
POST
/service/asset/action/delete
Delete an existing asset
asset.delete 1 param → 200x-Errors
POST
/service/asset/action/get
Returns media or EPG asset by media / EPG internal or external identifier
asset.get 1 param → 200x-Errors
POST
/service/asset/action/getAdsContext
Returns the data for ads control
asset.getAdsContext 1 param → 200x-Errors
POST
/service/asset/action/getPlaybackContext
This action delivers all data relevant for player
asset.getPlaybackContext 1 param → 200x-Errors
POST
/service/asset/action/list
Returns media or EPG assets. Filters by media identifiers or by EPG internal or external identifier.
asset.list 1 param → 200
POST
/service/asset/action/removeMetasAndTags
remove metas and tags from asset
asset.removeMetasAndTags 1 param → 200x-Errors
POST
/service/asset/action/update
update an existing asset
asset.update 1 param → 200x-Errors

Schemas 94

The contract defines 94 schemas that model the data the API accepts and returns. The most detailed are KalturaMediaFile (20 properties), KalturaAsset (16 properties), KalturaMediaImage (7 properties), KalturaProductPriceFilter (6 properties). Each schema is shown below with its type and property counts.

KalturaConfigurationGroupTagFilter
object
Configuration group tag filter
2 properties
KalturaSocialActionFilter
object
4 properties
KalturaPersistedFilter
object
abstract
2 properties
KalturaPlaybackContext
object
3 properties
KalturaAssetGroupBy
object
abstract Abstarct class - represents an asset parameter that can be used for grouping
1 property
KalturaCountryFilter
object
Country filter
4 properties
KalturaFilter
object
abstract
2 properties
KalturaRegionFilter
object
2 properties
KalturaOTTUserFilter
object
OTT User filter
4 properties
KalturaEngagementFilter
object
3 properties
KalturaDoubleValue
object
A string representation to return an array of doubles
1 property
KalturaReminderFilter
object
abstract
1 property
KalturaAssetHistoryFilter
object
5 properties
KalturaAssetListResponse
object
Asset wrapper
1 property
KalturaAdsContext
object
1 property
KalturaAssetCount
object
Asset count - represents a specific value of the field, its count and its sub groups.
3 properties
KalturaReportFilter
object
abstract Report filter
2 properties
KalturaMultilingualStringValueArray
object
Array of translated strings
1 property
KalturaPluginData
object
KalturaSeriesRecordingFilter
object
Filtering recordings
1 property
KalturaMetaFilter
object
Meta filter
5 properties
KalturaChannelsFilter
object
4 properties
KalturaAssetStructFilter
object
Filtering Asset Structs
4 properties
KalturaHouseholdUserFilter
object
2 properties
KalturaDynamicOrderBy
object
Kaltura Asset Order
2 properties
KalturaRuleAction
object
1 property
KalturaAssetFieldGroupBy
object
Group by a field that is defined in enum
1 property
KalturaSeasonsReminderFilter
object
3 properties
KalturaSocialCommentFilter
object
5 properties
KalturaAccessControlMessage
object
2 properties
KalturaFollowTvSeriesFilter
object
1 property
KalturaDrmPlaybackPluginData
object
2 properties
KalturaValue
object
abstract A representation to return an array of values
2 properties
KalturaAnnouncementFilter
object
order announcements
1 property
KalturaSubscriptionFilter
object
4 properties
KalturaFilterPager
object
The KalturaFilterPager object enables paging management to be applied upon service list actions
2 properties
KalturaImageTypeFilter
object
3 properties
KalturaPlaybackSource
object
3 properties
KalturaExportTaskFilter
object
Bulk export tasks filter
2 properties
KalturaDeviceReportFilter
object
Report filter
1 property
KalturaUserAssetRuleFilter
object
User asset rule filter
3 properties
KalturaBookmarkFilter
object
Filtering Assets requests
3 properties
KalturaIntegerValue
object
A string representation to return an array of ints
1 property
KalturaFavoriteFilter
object
Favorite request filter
4 properties
KalturaStringValue
object
A string representation to return an array of strings
1 property
KalturaSubscriptionSetFilter
object
4 properties
KalturaAsset
object
abstract Asset info
16 properties
KalturaSearchHistoryFilter
object
1 property
KalturaProductPriceFilter
object
6 properties
KalturaAssetsCount
object
Single aggregation objects
2 properties
KalturaBooleanValue
object
A string representation to return an array of booleans
1 property
KalturaCollectionFilter
object
Collection Filter
3 properties
KalturaAggregationCountFilter
object
Kaltura Aggregation CountFilter
1 property
KalturaAssetReminderFilter
object
1 property
KalturaPersonalFeedFilter
object
1 property
KalturaProgramAsset
object
Program-asset info
5 properties
KalturaInboxMessageFilter
object
4 properties
KalturaListResponse
object
Base list wrapper
1 property
KalturaPaymentMethodProfileFilter
object
2 properties
KalturaCurrencyFilter
object
Currency filter
2 properties
KalturaSeriesReminderFilter
object
3 properties
KalturaParentalRuleFilter
object
2 properties
KalturaMediaFile
object
Media file details
20 properties
KalturaAdsSource
object
4 properties
KalturaTopicFilter
object
1 property
KalturaMediaFileFilter
object
3 properties
KalturaUserRoleFilter
object
User roles filter
3 properties
KalturaRecordingFilter
object
Filtering recordings
3 properties
KalturaConfigurationsFilter
object
Configuration filter
2 properties
KalturaPriceDetailsFilter
object
2 properties
KalturaMultilingualStringValue
object
Array of translated strings
2 properties
KalturaHouseholdDeviceFilter
object
3 properties
KalturaTransactionHistoryFilter
object
Transactions filter
4 properties
KalturaEntitlementFilter
object
Entitlements filter
4 properties
KalturaTranslationToken
object
Container for translation
2 properties
KalturaRelatedFilter
object
3 properties
OTTRequest
object
2 properties
KalturaRecordingContextFilter
object
Filtering assets
2 properties
KalturaBaseSearchAssetFilter
object
abstract
2 properties
KalturaImageFilter
object
5 properties
KalturaAssetFilter
object
2 properties
KalturaSocialFriendActivityFilter
object
4 properties
KalturaLongValue
object
A string representation to return an array of longs
1 property
KalturaAssetMetaOrTagGroupBy
object
Group by a tag or meta - according to the name that appears in the system (similar to KSQL)
1 property
KalturaMediaImage
object
Image details
7 properties
KalturaLanguageFilter
object
Language filter
2 properties
KalturaPlaybackContextOptions
object
4 properties
KalturaTagFilter
object
5 properties
KalturaAssetCommentFilter
object
3 properties
KalturaRelatedObjectFilter
object
abstract Define KalturaRelatedObjectFilter
1 property
KalturaConfigurationGroupDeviceFilter
object
Configuration group device filter
2 properties
KalturaPricePlanFilter
object
2 properties
KalturaMediaAsset
object
Media-asset info
5 properties
KalturaSearchAssetFilter
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kaltura-asset-api-openapi.yml Raw ↑

Other APIs Kaltura publishes across the network.

Kaltura accessControl API
Kaltura accessControlProfile API
Kaltura adminUser API
Kaltura analytics API
Kaltura annotation API
Kaltura announcement API
Kaltura appToken API
Kaltura aspera API
Kaltura assetComment API
Kaltura assetFile API
Kaltura assetHistory API
Kaltura assetStatistics API