Media upload

Create a new media in the specified collection from an existing file accessible by URL

post/collections/{collection_id}/media

Request

  • Base URL
    https://tw.instructuremedia.com/api/public/v1
  • Auth
    API key in header Authorization

Path parameters

collection_idinteger required

The ID of the collection

Query parameters

urlstring required

The originating URL where the media can be retrieved.

titlestring

The title of the media. Required for non-external media.

descriptionstring

The description of the media.

auto_captionboolean

Whether to request auto-captioning for the media (false by default). This option is only available if auto-captioning is enabled for your account.

user_idinteger

An admin user can create the media on behalf of a user by specifying the user ID.

is_externalboolean

Whether the media is external (false by default). Only YouTube and Vimeo URLs are supported.

Response

The media has been uploaded.

Changes

No recorded changes to this operation across all 1 revision of this API.