INinstructure
Media upload

Create a new media in "My Uploads" or specified collection from an existing file accessible by URL

post/media

Request

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

Request body

urlstring required

The originating URL where the media can be retrieved.

titlestring

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

user_idinteger

ID of the user to upload the media on behalf of. if not provided, the video will be uploaded to requestor's user library

descriptionstring

The description of the media.

collection_idinteger

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

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.

is_externalboolean

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

Response

The media object that was created.

Changes

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