Studio API
Last updated
Was this helpful?
Last updated
Was this helpful?
This endpoint will delete a service type for a captioning service and will remove the associated captioning roles from it.
machine readable “id” that will be included with caption file requests when a CaptionService lists available requests.
No Content
The name of the collection.
ID of the user to create the collection on behalf of. If not provided, the collection will be created in the requestor's library
This endpoint returns a csv file containing video views, time viewed, unique viewers and time based viewership data.
The ID of the perspective.
A role to filter the users by. If not provided all insights data is aggregated.
No Content
This endpoint returns a csv file containing user name, email, role(s), completion rate and time based completion data.
The ID of the perspective.
A role to filter the users by. If not provided all insights data is aggregated.
No Content
The ID of the collection
The title of the media.
The originating URL where the media can be retrieved.
The description of the media.
Whether to request auto-captioning for the media (false by default). This option is only available if auto-captioning is enabled for your account.
Substring of the media title you want to search for.
Minimum size of the media in bytes.
Maximum size of the media in bytes.
Start date of the search interval. Format YYYY-MM-DD
End date of the search interval. Format YYYY-MM-DD
Email address of the owner of the media.
The full name of the tag, you want to list media objects for.
The source of the media you want to list media objects for.
The page to retrieve. Default: 1.
The number of results per page. Default: 20, Max: 50.
The ID of the user.
The number of the page you want to query. Default 1
The number of items per page. Default 20, maximum 50
This endpoint lists caption requests. It works both with auth token and the captioning service auth headers.
Provider of the caption. The only option is "professional"
Status of the caption request. The only possible value now is "requested"
This endpoint should be used to update a pending caption file request. Each request can be updated once with either fulfilled or failed status.
The id of the caption file request to be updated.
Result of the file request.
In case the caption creation was not successful you can provide some detail why it could not be completed.
The file to be uploaded. The supported file extension is .srt!
No Content
The endpoint will insert or update a service type for a captioning service. This endpoint only supports IETF language code
machine readable “id” that will be included with caption file requests when a CaptionService lists available requests.
IETF language code
The ID of the collection.
The action to perform.
The id of the user or group.
The share type.
The permission type. The default is "view".
viewAvailable options: This endpoint will update the users and their permissions for a group
ID of the group to update users and their permissions
Type of action to perform
ID of the user to perform the action on
Permission to set for the user when action is add or update
The title of the media.
The originating URL where the media can be retrieved.
^http[s]?:\/?\/ID of the user to upload the media on behalf of. if not provided, the video will be uploaded to requestor's user library
The description of the media.
The ID of a collection, user_id and collection_id can not be sent together as if user_id is provided the media will be uploaded to user's user library
Whether to request auto-captioning for the media (false by default). This option is only available if auto-captioning is enabled for your account.
Signifies that a media file has been uploaded to a previously-created upload URL and is ready to appear in "My Uploads"
The ID of the media.
The title of the media.
The description of the media.
Whether to request auto-captioning for the media (false by default). This option is only available if auto-captioning is enabled for your account.
The ID of the media.
The action to perform.
The id of the user or group.
The share type.
The permission type. The default is "view".
viewAvailable options: The ID of the media.
Id of the course to embed the media in.
The type of the embed. Studio uses "embed" to create embedding with media tabs and "bare_embed" to create one with only the media player.
A flag that controlls if the embedded media should be downloadable or not.
The endpoint transfers all not shared media objects owned by the user to a new owner. We transfer the media objects themselves, all perspectives stored in the "My Library" and in custom collections.