QUICK TIP

Wish to contribute your media to TIH? Learn how to do so by referring API User Guide - Media.
You will also need an OAuth key to get started

.

Document

Method
Description

POST

createDocument

https://tih-api.stb.gov.sg/media/v1/admin/document

Allow the creation of a Document metadata. To create successfully, the following input parameters are mandatory: name, category, subCategory, libraryUuid and tags. Approach is to create a Library and retrieve the libraryUuid, prior to creating a Document metadata. Once the Document metadata has been created, proceed to upload the document asset using uploadMedia API.

DELETE

deleteDocument

https://tih-api.stb.gov.sg/media/v1/admin/document/{uuid}

Allow the deletion of an existing Document through the use of a UUID. The acronym for unique identifier is UUID. This UUID is created when you submit a media content. This can be found in API JSON response. If you have not documented the UUID, you can fetch it by using documentSearchByKeyword API.

GET

documentSearchByKeyword

https://tih-api.stb.gov.sg/media/v1/admin/document/search

Perform a search on Documents based on a keyword. The query parameters include: keyword, sort and next token. The mandatory field for this request is keyword.

PUT

updateDocument

https://tih-api.stb.gov.sg/media/v1/admin/document/{uuid}

Allow an existing Document to be updated through the use of a unique identifier. The acronym for unique identifier is UUID. This UUID is created when you submit a media content. This can be found in API JSON response. If you have not documented the UUID, you can fetch it by using documentSearchByKeyword API.

Image

Method
Description

POST

createImage

https://tih-api.stb.gov.sg/media/v1/admin/image

Allow the creation of an Image metadata. To create successfully, the following input parameters are mandatory: name, category, subCategory, libraryUuid and tags. Approach is to create a Library and retrieve the libraryUuid, prior to creating an Image metadata. Once the Image metadata has been created, proceed to upload the image asset using uploadMedia API.

DELETE

deleteImage

https://tih-api.stb.gov.sg/media/v1/admin/image/{uuid}

Allow the deletion of an existing Image through the use of a UUID. The acronym for unique identifier is UUID. This UUID is created when you submit a media content. This can be found in API JSON response. If you have not documented the UUID, you can fetch it by using imageSearchByKeyword API.

GET

imageSearchByKeyword

https://tih-api.stb.gov.sg/media/v1/admin/image/search

Perform a search on Images based on a keyword. The query parameters include: keyword, sort and next token. The mandatory field for this request is keyword.

PUT

updateImage

https://tih-api.stb.gov.sg/media/v1/admin/image/{uuid}

Allow an existing Image to be updated through the use of a unique identifier. The acronym for unique identifier is UUID. This UUID is created when you submit a media content. This can be found in API JSON response. If you have not documented the UUID, you can fetch it by using imageSearchByKeyword API.

Library

Method
Description

POST

createLibrary

https://tih-api.stb.gov.sg/media/v1/admin/library

Allow the creation of a library. Approach to contributing media is to create a library first and, associate the media with the library. The libraryUuid (a unique identifier for the library) generated in the response of this API would be required in the next step to create a media (e.g. document, image, video). To create successfully, the following input parameters are mandatory: name, description, category, subCategory and tags.

DELETE

deleteLibrary

https://tih-api.stb.gov.sg/media/v1/admin/library/{uuid}

Allow the deletion of an existing Library through the use of a UUID. The acronym for unique identifier is UUID. This UUID is created when you submit a media content. This can be found in API JSON response. If you have not documented the UUID, you can fetch it by using librarySearchByKeyword API.

GET

librarySearchByKeyword

https://tih-api.stb.gov.sg/media/v1/admin/library/search

Perform a search on Media Libraries based on a keyword. The query parameters include: keyword, sort and next token. The mandatory field for this request is keyword.

PUT

updateLibrary

https://tih-api.stb.gov.sg/media/v1/admin/library/{uuid}

Allow an existing Library to be updated through the use of a unique identifier. The acronym for unique identifier is UUID. This UUID is created when you submit a media content. This can be found in API JSON response. If you have not documented the UUID, you can fetch it by using librarySearchByKeyword API.

Video

Method
Description

POST

createVideo

https://tih-api.stb.gov.sg/media/v1/admin/video

Allow the creation of a Video metdata. To create successfully, the following input parameters are mandatory: name, category, subCategory, libraryUuid and tags. Approach is to create a Library and retrieve the libraryUuid, prior to creating a Video metadata. Once the Video metadata has been created, proceed to upload the video asset using uploadMedia API.

DELETE

deleteVideo

https://tih-api.stb.gov.sg/media/v1/admin/video/{uuid}

Allow the deletion of an existing Video through the use of a UUID. The acronym for unique identifier is UUID. This UUID is created when you submit a media content. This can be found in API JSON response. If you have not documented the UUID, you can fetch it by using videoSearchByKeyword API.

PUT

updateVideo

https://tih-api.stb.gov.sg/media/v1/admin/video/{uuid}

Allow an existing Video to be updated through the use of a unique identifier. The acronym for unique identifier is UUID. This UUID is created when you submit a media content. This can be found in API JSON response. If you have not documented the UUID, you can fetch it by using videoSearchByKeyword API.

GET

videoSearchByKeyword

https://tih-api.stb.gov.sg/media/v1/admin/video/search

Perform a search on Videos based on a keyword. The query parameters include: keyword, sort and next token. The mandatory field for this request is keyword.

Upload

Method
Description

POST

uploadMedia

https://tih-api.stb.gov.sg/media/v1/admin/upload/uuid/{uuid}

To upload actual content of the Media files, using the UUID generated from creating the Image, Video and Document metadata.