Media Provider API

QUICK TIP

Wish to contribute your media to TIH? Learn how to do so by downloading our technical documentation.
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

Allows the creation of a Document. To create successfully, the  following input parameters are mandatory: name, description, category, subCategory and tags.

DELETE

deleteDocument

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

Allows 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 Swagger 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

Performs 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}

Allows 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 Swagger 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

Allows the creation of a Image. To create successfully, the  following input parameters are mandatory: name, description, category, subCategory, libraryUuid and tags.

DELETE

deleteImage

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

Allows 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 Swagger 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

Performs 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}

Allows 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 Swagger 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

Allows the creation of a Library. 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}

Allows 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 Swagger 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

Performs 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}

Allows 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 Swagger 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

Allows the creation of a Video. To create successfully, the  following input parameters are mandatory: name, description, category, subCategory, libraryUuid and tags.

DELETE

deleteVideo

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

Allows 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 Swagger 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}

Allows 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 Swagger 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

Performs 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 there UUID like Image, Video and Document.