Welcome to the Panopto Community

Please note: All new registrants to the Panopto Community Forum must be approved by a forum moderator or admin. As such, if you navigate to a feature that is members-only, you may receive an error page if your registration has not yet been approved. We apologize for any inconvenience and are approving new members as quickly as possible.

API questions for embedded videos

Daniel TateDaniel Tate Tyro
in API

API
Our aim would be to be able to load the video files into the Omeka platform for long-term preservation and indexing the content for the search interface. Can you ask Panopto whether they have an API which would allow us to do the following things:

Upload a new video into a specific folder, setting basic data like title
Attach a subtitles file (closed captions, e.g. in SRT or VTT format) to a video
Set the preferred featured image to be used before the video is playing
Delete a video from the folder

If the featured image can only be set in Panopto, then it would be useful if the API allowed us to retrieve it, as we need to be able to set a thumbnail in Omeka for the search results pages.

If Panopto is capable of creating closed captions by audio recognition of the video, it would also be useful to know if the API allows retrieval of the closed captions or transcript so that we could store and index them in Omeka. For our initial batch of 800 videos, we already have close caption files generated, but it might be helpful when adding new videos in the future to be able to have Panopto generate captions.

If their API does do some or all of the above things, pointers to documentation, integration code for PHP or Python, etc. would be useful.

Answers

  • Adis HrnjicaAdis Hrnjica Whiz Kid

    Hi Daniel,

    Yes. The public API covers this…Docs here

    • Upload into a folder, with a title: Sessions → Create a session (Name, FolderId). The video file itself goes through the session upload API
    • SRT or VTT: Sessions → Upload a caption file
    • Featured image: read Urls.ThumbnailUrl on Get a session by Id (also returned by search). Setting a custom image is not in this API
    • Delete: Sessions → Delete a session
    • Speech-recognition captions: set the folder caption provider under Folders → Update folder settings. Download them from Urls.CaptionDownloadUrl on Get a session by Id

    Usage of the REST API should be pretty straight forward but let me know if you have questions.

    Thanks,

    -Adis

Sign In or Register to comment.