Videos

List all video objects

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

get/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 6 of the 50 revisions of this API.91117

Oct 8, 2024ac1f7d2cfd032See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
Sep 16, 2024e68c2c97ad653See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
Apr 16, 2024ec2b79bfdc8d1See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
Jul 5, 202351add04284a126See the full diff
- ▲
  the query request parameter sortBy was restricted to a list of enum values
  request-parameter-became-enum
- ▲
  the query request parameter sortOrder was restricted to a list of enum values
  request-parameter-became-enum
- ○
  added the new enum value asc to the query request parameter sortOrder
  request-parameter-enum-value-added
- ○
  added the new enum value createdAt to the query request parameter sortBy
  request-parameter-enum-value-added
- ○
  added the new enum value desc to the query request parameter sortOrder
  request-parameter-enum-value-added
- ○
  added the new enum value publishedAt to the query request parameter sortBy
  request-parameter-enum-value-added
- ○
  added the new enum value title to the query request parameter sortBy
  request-parameter-enum-value-added
- ○
  added the new enum value updatedAt to the query request parameter sortBy
  request-parameter-enum-value-added
Apr 28, 2022f9532dd3578c2See the full diff
- ○
  the endpoint scheme security apiKey was added to the API
  api-security-added
- ○
  the endpoint scheme security bearerAuth was removed from the API
  api-security-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 7, 20222a4d90a64f887113See the full diff
- ▲
  removed the enum value asc from the query request parameter sortOrder
  request-parameter-enum-value-removed
- ▲
  removed the enum value createdAt from the query request parameter sortBy
  request-parameter-enum-value-removed
- ▲
  removed the enum value desc from the query request parameter sortOrder
  request-parameter-enum-value-removed
- ▲
  removed the enum value publishedAt from the query request parameter sortBy
  request-parameter-enum-value-removed
- ▲
  removed the enum value title from the query request parameter sortBy
  request-parameter-enum-value-removed
- ▲
  removed the enum value updatedAt from the query request parameter sortBy
  request-parameter-enum-value-removed
- ▲
  the // response's property format changed from date-time to no format for status
  response-property-type-changed
- ●
  the optional response header X-RateLimit-Limit removed for the status 200
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Limit removed for the status 400
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Remaining removed for the status 200
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Remaining removed for the status 400
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Retry-After removed for the status 200
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Retry-After removed for the status 400
  optional-response-header-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ○
  the endpoint scheme security bearerAuth was added to the API
  api-security-added
- ○
  the endpoint scheme security apiKey was removed from the API
  api-security-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed
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