Gets all media

Returns a listing of videos and images as specified with optional pagination parameters:

  • offset sets the starting position for the pagination (starting at nth result)
  • limit sets the page size (how many results per page)

The media can be fitlered according to the following properties (also optional) which can also be used as query parameters:

  • status is the status of the media prediction, which can be init, started, done or failed
  • type can be either image or video

Example of a successful response

When getting a list of existing media, this is what the response will look like:

{
  "items": [
    {
      "media_id": "d1ed7b0c-59dd-4288-86fe-09cc17ae1d73",
      "name": "media_image",
      "status": "done",
      "type": "image",
      "aoi_status": "unspecified",
      "results": {
        "..."
      },
      "metrics": {
        "cognitive_demand": 52.00257641656162,
        "focus": 61.60770189508884,
        "focus_first_two": 73.39767200608647,
        "focus_last_two": 36.575161748222804,
        "clarity": 64.35,
        "engagement": 31.34
      },
      "created_at": "2023-12-28T10:39:39Z",
      "updated_at": "2023-12-28T10:40:47Z",
      "deleted_at": null
    },
    {
      "media_id": "a9308e89-f742-4d94-86fa-009f5c623a64",
      "name": "media_video",
      "status": "done",
      "type": "video",
      "aoi_status": "unspecified",
      "results": {
        "..."
      },
      "metrics": {
        "cognitive_demand": 91.74320443539042,
        "focus": 39.43070868238291,
        "focus_first_two": 68.72111499753947,
        "focus_last_two": 13.071559441773944,
        "clarity": null,
        "engagement": null
      },
      "created_at": "2024-01-08T10:46:02Z",
      "updated_at": "2024-01-08T10:51:13Z",
      "deleted_at": null
    }
  ],
  "count": 2,
  "total": 38
}
Language
Credentials
Header
Click Try It! to start a request and see the response here!