Get all videos

Use this endpoint to retrieve information about all videos in your account. The identifier is used in all endpoints to uniquely identify a video. The videos are sorted based creation time by default.

Parameter	Type	Description
status	string	Status to filter. Choose from: in_progress, failed, update_done, draft, draft_in_progress, done, update_failed, update_in_progress. You can pass multiple status separated by commas.
start_date	string	Filter based on the start date of the last modification. Date format: YYYY-MM-DD.
end_date	string	Filter based on the end date of the last modification. Date format: YYYY-MM-DD.
search	string	Search by title to filter the results.
take	string	Maximum number of records to retrieve in a single request. The maximum value is 100.
skip	string	Number of records to skip before starting to return results.
sortField	string	The field to sort the videos by. Values are created and updated.
sortType	string	Sort order. Choose from: asc (ascending) or desc (descending).

HTTP Request

GET https://api.oxolo.com/v1/api/videos

curl -X 'GET' 
'https://api.oxolo.com/v1/api/videos?status=done&start_date=2023-03-01&end_date=2023-03-06&search=title&take=100&skip=0&sortField=created&sortType=desc' 
-H 'accept: application/json' 
-H 'authorization: YOUR_API_KEY'

Result

{
  results: [
    {
      identifier: "{VIDEO_IDENTIFIER}",
      state: "{VIDEO_STATE}",
      status: "{VIDEO_STATUS}",
      progress: "{VIDEO_PROGRESS}",
      remainingTime: "{VIDEO_PROCESS_REMAINING_TIME}",
      stagText: "{VIDEO_STAGE_TEXT}",
      un_wateremark_link: "{VIDEO_LINK}", //(Will deprecate in next version. prefer to use 'video_link')
      thumbnail: "{VIDEO_THUMBNAIL}",
      generated_from: "{VIDEO_MODE}",
      title: "{VIDEO_TITLE}",
      video_link: "{VIDEO_LINK}",
      duration: "{VIDEO_DURATION}",
      target_platform: "{VIDEO_TARGET_PLATFORM}",
      target_language: "{VIDEO_TARGET_LANGUAGE}",
      created: "{VIDEO_CREATION_TIME}",
      updated: "{VIDEO_UPDATE_TIME}",
      "..."
    },
    pagination: {
        skip: {SKIP},
        take: {TAKE},
        total: {TOTAL_OBJECT}
    },
  ],
}