Videos

List all discarded video objects

List all the video objects that are associated with the current workspace.

get/discarded/videos

Query parameters

titlestring

The title of a specific video you want to find. The search will match exactly to what term you provide and return any videos that contain the same term as part of their titles.

tags[]string[]

A tag is a category you create and apply to videos. You can search for videos with particular tags by listing one or more here. Only videos that have all the tags you list will be returned.

metadataobject

Videos can be tagged with metadata tags in key:value pairs. You can search for videos with specific key value pairs using this parameter.

descriptionstring

Retrieve video objects by description.

liveStreamIdstring

Retrieve video objects that were recorded from a live stream by liveStreamId.

sortBy'title' | 'createdAt' | 'publishedAt' | 'updatedAt'

Use this parameter to sort videos by the their created time, published time, updated time, or by title.

sortOrder'asc' | 'desc'

Use this parameter to sort results. asc is ascending and sorts from A to Z. desc is descending and sorts from Z to A.

currentPageinteger

Choose the number of search results to return per page. Minimum value: 1

pageSizeinteger

Results per page. Allowed values 1-100, default is 25.

Response

Success

Example response

{
  "pagination": {
    "itemsTotal": 123,
    "pagesTotal": 7,
    "pageSize": 20,
    "currentPage": 3,
    "currentPageItems": 20,
    "links": {
      "first": {
        "rel": "first",
        "uri": "/videos/search?currentPage=1&pageSize=20"
      },
      "previous": {
        "rel": "previous",
        "uri": "/videos/search?currentPage=2&pageSize=20"
      },
      "next": {
        "rel": "next",
        "uri": "/videos/search?currentPage=4&pageSize=20"
      },
      "last": {
        "rel": "last",
        "uri": "/videos/search?currentPage=6&pageSize=20"
      }
    }
  },
  "data": [
    {
      "videoId": "vi4k0jvEUuaTdRAEjQ4Jfrgz",
      "title": "Maths video",
      "description": "An amazing video explaining the string theory",
      "language": "en",
      "languageOrigin": "api",
      "tags": [
        "maths",
        "string theory",
        "video"
      ],
      "metadata": [
        {
          "key": "Author",
          "value": "John Doe"
        },
        {
          "key": "Format",
          "value": "Tutorial"
        }
      ],
      "createdAt": "2024-03-03T12:52:03+00:00",
      "publishedAt": "2024-07-14T23:36:07+00:00",
      "discarded": false,
      "discardedAt": null,
      "deletesAt": null,
      "actions": [
        "video_delete",
        "video_download",
        "video_update"
      ]
    },
    {
      "videoId": "vi4k0jvEUuaTdRAEjQ4Jfrgz",
      "title": "Maths video",
      "description": "An amazing video explaining the string theory",
      "language": "en",
      "languageOrigin": "api",
      "tags": [
        "maths",
        "string theory",
        "video"
      ],
      "metadata": [
        {
          "key": "Author",
          "value": "John Doe"
        },
        {
          "key": "Format",
          "value": "Tutorial"
        }
      ],
      "createdAt": "2024-03-03T12:52:03+00:00",
      "publishedAt": "2024-07-14T23:36:07+00:00",
      "discarded": false,
      "discardedAt": null,
      "deletesAt": null,
      "actions": [
        "video_delete",
        "video_download",
        "video_update"
      ]
    }
  ]
}

Changes

Changed in 3 of the 50 revisions of this API.13

Oct 8, 2024ac1f7d2cfd032See the full diff
- ○
  added the optional property data/items/language to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/items/languageOrigin to the response with the 200 status
  response-optional-property-added
Sep 16, 2024e68c2c97ad651See the full diff
- ○
  endpoint added
  endpoint-added
Feb 7, 20222a4d90a64f881See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 32 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 50 revisions, 1 has no diff computed.

Full history