{ "opencollection": "1.0.0", "info": { "name": "Kaltura OTT accessControl media API", "version": "3.6.287.20720" }, "items": [ { "info": { "name": "media", "type": "folder" }, "items": [ { "info": { "name": "media.add", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/add", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Add entry" }, { "info": { "name": "media.addContent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/addContent", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Add content to media entry which is not yet associated with content (therefore is in status NO_CONTENT).\n If the requirement is to replace the entry's associated content, use action updateContent." }, { "info": { "name": "media.addFromBulk", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/addFromBulk", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Adds new media entry by importing an HTTP or FTP URL.\n\nThe entry will be queued for import and then for conversion.\n\nThis action should be exposed only to the batches" }, { "info": { "name": "media.addFromEntry", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/addFromEntry", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Copy entry into new entry" }, { "info": { "name": "media.addFromFlavorAsset", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/addFromFlavorAsset", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Copy flavor asset into new entry" }, { "info": { "name": "media.addFromRecordedWebcam", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/addFromRecordedWebcam", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Add new entry after the file was recorded on the server and the token id exists" }, { "info": { "name": "media.addFromSearchResult", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/addFromSearchResult", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Adds new media entry by importing the media file from a search provider.\n\nThis action should be used with the search service result." }, { "info": { "name": "media.addFromUploadedFile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/addFromUploadedFile", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Add new entry after the specific media file was uploaded and the upload token id exists" }, { "info": { "name": "media.addFromUrl", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/addFromUrl", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Adds new media entry by importing an HTTP or FTP URL.\n\nThe entry will be queued for import and then for conversion." }, { "info": { "name": "media.anonymousRank", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/anonymousRank", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Anonymously rank a media entry, no validation is done on duplicate rankings" }, { "info": { "name": "media.approve", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/approve", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Approve the media entry and mark the pending flags (if any) as moderated (this will make the entry playable)" }, { "info": { "name": "media.approveReplace", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/approveReplace", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Approves media replacement" }, { "info": { "name": "media.bulkUploadAdd", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/bulkUploadAdd", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "bulkUploadData[objectType]", "value": "", "type": "query" }, { "name": "bulkUploadData[fileName]", "value": "", "type": "query", "description": "Friendly name of the file, used to be recognized later in the logs." }, { "name": "bulkUploadData[objectData][objectType]", "value": "", "type": "query" }, { "name": "bulkUploadData[emailRecipients]", "value": "", "type": "query", "description": "Recipients of the email for bulk upload success/failure" }, { "name": "bulkUploadData[numOfErrorObjects]", "value": "", "type": "query", "description": "Number of objects that finished on error status" }, { "name": "bulkUploadData[privileges]", "value": "", "type": "query", "description": "privileges for the job" }, { "name": "bulkUploadEntryData[objectType]", "value": "", "type": "query" }, { "name": "bulkUploadEntryData[conversionProfileId]", "value": "", "type": "query", "description": "Selected profile id for all bulk entries" } ] }, "docs": "Add new bulk upload batch job\n\nConversion profile id can be specified in the API or in the CSV file, the one in the CSV file will be stronger.\n\nIf no conversion profile was specified, partner's default will be used" }, { "info": { "name": "media.cancelReplace", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/cancelReplace", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Cancels media replacement" }, { "info": { "name": "media.convert", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/convert", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Convert entry" }, { "info": { "name": "media.count", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/count", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Count media entries by filter." }, { "info": { "name": "media.delete", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/delete", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Delete a media entry." }, { "info": { "name": "media.exportToCsv", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/exportToCsv", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Creates a batch job that sends an email with a link to download a CSV containing a list of entries" }, { "info": { "name": "media.flag", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/flag", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Flag inappropriate media entry for moderation" }, { "info": { "name": "media.get", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/get", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Get media entry by ID." }, { "info": { "name": "media.getMrss", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/getMrss", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Get MRSS by entry id\n XML will return as an escaped string" }, { "info": { "name": "media.getVolumeMap", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/getVolumeMap", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Get volume map by entry id" }, { "info": { "name": "media.list", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/list", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "List media entries by filter with paging support." }, { "info": { "name": "media.listFlags", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/listFlags", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "List all pending flags for the media entry" }, { "info": { "name": "media.reject", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/reject", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Reject the media entry and mark the pending flags (if any) as moderated (this will make the entry non playable)" }, { "info": { "name": "media.requestConversion", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/requestConversion", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Request a new conversion job, this can be used to convert the media entry to a different format" }, { "info": { "name": "media.update", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/update", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Update media entry. Only the properties that were set will be updated." }, { "info": { "name": "media.updateContent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/updateContent", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Replace content associated with the media entry." }, { "info": { "name": "media.updateThumbnail", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/updateThumbnail", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Update media entry thumbnail by a specified time offset (In seconds)\n\nIf flavor params id not specified, source flavor will be used by default" }, { "info": { "name": "media.updateThumbnailFromSourceEntry", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/updateThumbnailFromSourceEntry", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Update media entry thumbnail from a different entry by a specified time offset (In seconds)\n\nIf flavor params id not specified, source flavor will be used by default" }, { "info": { "name": "media.updateThumbnailFromUrl", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/updateThumbnailFromUrl", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "clientTag", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Update entry thumbnail using URL" }, { "info": { "name": "media.updateThumbnailJpeg", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/updateThumbnailJpeg", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" }, { "name": "entryId", "value": "", "type": "query", "description": "Media entry id" } ] }, "docs": "Update media entry thumbnail using a raw jpeg file" }, { "info": { "name": "media.upload", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/service/media/action/upload", "params": [ { "name": "ks", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query", "description": "The format of the response" } ] }, "docs": "Upload a media file to Kaltura, then the file can be used to create a media entry." } ] } ], "bundled": true }