Media API

QUICK TIP

Identified the media you would like to use?
Get started by downloading our technical documentation.

360 Image

Method
Description

GET

360imageByUUID

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

Perform a search on 360 Image based on UUID. You can retieve the UUID from a media provider API while creating a media library. This returns the result of media that belongs to media type 360image only.

GET

360imageSearchByKeyword

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

Perform a search on 360 Images based on keyword. The query parameters include: keyword and sort. This returns the result of media that belongs to media type 360image only.

360 Video

Method
Description

GET

360videoByUUID

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

Perform a search on 360 Video based on UUID. You can retieve the UUID from a media provider API while creating a media library. This returns the result of media that belongs to media type 360video only.

GET

360videoSearchByKeyword

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

Perform a search on 360 Video based on keyword. The query parameters include: keyword and sort. This returns the result of media that belongs to media type 360video only.

General

Method
Description

GET

autoCompleteByType

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

Provide a list of autocomplete results.

GET

getTags

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

Return list of Tag

Document

Method
Description

GET

documentByUUID

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

Perform a search on Document based on UUID. You can retrieve the UUID from a media provider API while creating a media library. This returns the result of media that belongs to media type document only.

GET

documentSearchByKeyword

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

Perform a search on Document based on keyword. The query parameters include: keyword and sort . This returns the result of media that belongs to media type document only.

Download

Method
Description

GET

downloadMedia

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

Download media file. The query parameter includes file type. You can retieve the UUID from a media provider API while creating a media library.

Media

Method
Description

GET

getMediaByUUID

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

Perform a search on Media based on UUID. You can retieve the UUID from a media provider API while creating a media library. You can search with any media types by uuid (Example: image, document, video).

GET

listMediaTypes

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

Retrieve list of media types.

GET

searchMediaByKeyword

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

Perform a search on Media based on keyword. The query parameters include: keyword, category, media type, orientation and sort. You will get result of all media types, like image, document and video.

Image

Method
Description

GET

imageByUUID

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

Perform a search on Images based on UUID. The UUID generates while creating new Image using createImage from media provider API. This returns the result of media that belongs to media type image only.

GET

imageSearchByKeyword

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

Perform a search on Images based on keyword. The query parameters include: keyword, orientation and sort. This returns the result of media that belongs to media type image only.

Library

Method
Description

GET

libraryByUUID

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

Perform a search on Libraries based on UUID. You can retieve the UUID from a media provider API while creating a media library. It returns information of the library (name, category, description, source, mediaTypes, primaryFileType, primaryFile, primaryFileMediumUuid, primaryFileSmallUuid, etc.)

GET

librarySearchByKeyword

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

Perform a search on Libraries based on keyword. The query parameters include: keyword, category, media type, sort and next token.

GET

mediaBylibraryUUID

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

Retrieve a list of Media for Library.

Media Types

Method
Description

GET

listAccommodationTypes

https://tih-api.stb.gov.sg/media/v1/accommodation/types

Retrieve a list of Accommodation types, for example backpackers hostels, hotels, resorts, service apartments, and others.

GET

listAttractionTypes

https://tih-api.stb.gov.sg/media/v1/attractions/types

Retrieve a list of Attraction types, for example adventures,watersports, and others.

GET

listBarsClubsTypes

https://tih-api.stb.gov.sg/media/v1/bars-clubs/types

Retrieve a list of Bars and Clubs types, for example bars.

GET

listCruisesTypes

https://tih-api.stb.gov.sg/media/v1/cruises/types

Retrieve a list of Cruise types.

GET

listEventFestivitiesTypes

https://tih-api.stb.gov.sg/media/v1/event-festivities/types

Retrieve a list of Event types.

GET

listFoodBeveragesTypes

https://tih-api.stb.gov.sg/media/v1/food-beverages/types

Retrieve a list of Food and Beverage establishment types, for example café.

GET

listShopsTypes

https://tih-api.stb.gov.sg/media/v1/shops/types

Retrieve a list of Malls and Shops types, for example bazaar and flea markets.

GET

listTourTypes

https://tih-api.stb.gov.sg/media/v1/tour/types

Retrieve a list of Tour types, for example adventure and sports.

GET

listVenuesTypes

https://tih-api.stb.gov.sg/media/v1/venues/types

Retrieve a list of Venue types.

Video

Method
Description

GET

videoByUUID

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

Perform a search on Video based on UUID. You can retrieve the UUID from a media provider API while creating a media library. This returns the result of media that belongs to media type video only.

GET

videoSearchByKeyword

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

Perform a search on Video based on keyword. The query parameters include: keyword and sort. This returns the result of media that belongs to media type video only.