v1

latestOpenAPI 3.0.0Apache-2.02026-07-2683720.3 KB
MediaLibrary

Retrieve media

Retrieve media content and optionally filter by search criteria and mediaType. If no parameters are given, the app should return either the contents of the base folder if it has a folder hierarchy or trending/popular media results otherwise.

get/v1/media

Query parameters

parentIdstring

The ID of the parent folder that the user wants to get the children of.

cursorstring

A cursor returned by a previous call to this endpoint. Used to return the next page of results. All params from the previous request must be encoded in the cursor, so that a subsequent call can be made with only the cursor to fetch the next or previous page of results.

querystring

Search text entered by the user

pageSizeinteger

Number of results to return per page

Response

successful operation

Example response

{
  "data": [
    {
      "id": "12345qqq",
      "name": "my_picture.jpg",
      "altText": "Picture of a beautiful sunset",
      "mediaType": "Image",
      "mimeType": "image/jpeg",
      "original": {
        "url": "https://imagezzzz.com/my_image.jpg",
        "width": 200,
        "height": 200,
        "sizeInBytes": 300
      },
      "thumbnail": {
        "url": "https://imagezzzz.com/my_image_small.jpg",
        "width": 100,
        "height": 100
      },
      "durationInSeconds": 120,
      "subtitleFileName": "example.en_US.srt",
      "subtitles": "https://imagezzzz.com/my_subtitles.srt"
    }
  ],
  "metadata": {
    "cursor": {
      "next": "encodedxjatcd83nn39d99093kknext",
      "previous": "encodedxjatcd83nn39d99093kkprev"
    }
  }
}