POST Video Search

Overview

---

The following table contains important information about the POST method for managing the process of retrieving videos with pagination.

POST Video
Method	POST
URL or Endpoint	/api​/projects​/projectId​/videos/search
Parameters	projectId
Body	Check request body below.

The description of the URL parameters is as follows:

URL Parameter Name	Mandatory	Type	Description
projectId	Yes	string	Unique ID of the project.

Request Body

{
  "page": 0,
  "searchAfter": [
    null
  ],
  "folderId": 0,
  "folderView": true,
  "onlyReadyVideos": true,
  "onlyPublishedVideos": true,
  "key": "string",
  "value": "string",
  "author": "string",
  "videoPropertyType": 0,
  "videoPropertyValue": 0,
  "isLive": true,
  "parentVideoId": "string",
  "visibilityOptionIds": [
    0
  ],
  "search": "string",
  "order": "string",
  "insertDate": "2026-02-16T10:23:42.729Z",
  "take": 0
}

Information about the fields that appear when you type in the request body are displayed in the table below.

Parameter Name	Mandatory	Type	Description
page	No	integer	The page number to retrieve in a paginated result set. Typically starts from 0.
searchAfter	No	array	An array of values used for cursor-based pagination. Use the last value from the previous page for the next page.
folderId	No	integer	ID of the folder to filter videos by. Use 0 or omit for no folder filtering.
folderView	No	boolean	Indicates whether the response should be filtered or formatted according to folder view.
onlyReadyVideos	No	boolean	Filter to include only videos that are ready for playback or processing.
onlyPublishedVideos	No	boolean	Filter to include only videos that are published and visible to users.
key	No	string	Custom key used for filtering video properties.
value	No	string	Value corresponding to the key used for property filtering.
author	No	string	Filter videos by the author.
videoPropertyType	No	integer	Numeric identifier representing the type of video property to filter by.
videoPropertyValue	No	integer	Numeric value associated with videoPropertyType for filtering.
isLive	No	boolean	Filter videos to include only live videos or non-live videos.
parentVideoId	No	string	ID of a parent video to filter for child or related videos.
visibilityOptionIds	No	array[int]	List of visibility option IDs to filter videos by their visibility settings.
search	No	string	Search term to filter videos by.
order	No	string	Sorting order for the results.
insertDate	No	Date	Filter videos by their insertion date.
take	No	integer	The number of videos to retrieve per request.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "currentPage": 1,
    "totalPages": 65,
    "pageSize": 10,
    "totalCount": 644,
    "searchAfter": [
        1768837792185,
        8284
    ],
    "items": [
      {
        "title": "{title}",
        "mediaId": "{videoId}",
        "author": "{author}",
        "videoAuthor": "{videoAuthor}",
        "deletedBy": "{deletedBy}",
        "updateDate": "{updateDate}",
        "thumbnailUrl": "{thumbnailUrl}",
        "status": "{status}",
        "duration": 0.0,
        "publishDate": "2022-03-24T10:35:11.964Z",
        "canEmbed": false,
        "canPreview": false,
        "highlight": {},
        "folderId": null,
        "progress": 0,
        "progressTillReadiness": 0,
        "estimatedFinishTime": "{estimatedFinishTime}",
        "showEncodingProgress": false,
        "visibilityOptionId": 0,
        "visibilityOption": 0,
        "playbackUrl": "{playbackUrl}",
        "errorId": null,
        "error": null,
        "tags": [],
        "customParameters": [
          {
            "id": 0,
            "key": "{key}",
            "value": "{value}"
          }
        ],
        "videoProperties": null
      }
    ]
  },
  "resultInfo": null,
  "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false
errors	array[string]	Indicates if there was an error
messages	array[string]	Returns the response message from back-end
result	array[Object]	Returns the response object
currentPage	integer	Number of the current page
totalPages	integer	Number of the total page
pageSize	integer	The size of the page
totalCount	integer	Number of the total records
searchAfter	array	An array of values used for cursor-based pagination. Use the last value from the previous page for the next page.
items	array[Object]	Array of records, each containing details about the video
title	string	Title of the video
mediaId	string	Public Id of the video
author	string	Author of the video
videoAuthor	string	Author of the video content
deletedBy	string	Entity that deleted the video
updateDate	Date	The last update date of the video
thumbnailUrl	string	URL of the thumbnail image
status	string	Status of the video (e.g., "Ready")
duration	float	Duration of the video in seconds
publishDate	Date	The date when the video was published
canEmbed	bool	Indicates whether the video can be embedded
canPreview	bool	Indicates whether the video can be previewed
highlight	object	Contains highlight information (if any)
folderId	string	Folder ID where the video is stored (if applicable)
progress	integer	The current progress of the video processing (as percentage)
progressTillReadiness	integer	The progress towards readiness (as percentage)
estimatedFinishTime	string	The estimated finish time for the video processing
showEncodingProgress	bool	Indicates whether to show encoding progress
visibilityOptionId	integer	Visibility option ID (e.g., 1 for public visibility)
visibilityOption	string	Visibility option (e.g., "Public")
playbackUrl	string	URL for video playback
errorId	integer	Identifier for any error that occurred (if applicable)
error	string	Error message (if any)
tags	array[string]	Tags associated with the video
customParameters	array[Object]	Custom parameters related to the video, such as metadata
videoProperties	object	Additional properties related to the video (if applicable)
resultInfo	string	Extra information about the result
statusCode	integer	Returns the HTTP Status Code

info

For more information about the possible errorId and error values, see Error Codes.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed