Get video information
Use this endpoint to retrieve all information about a specific video, including a download link.
The
results
key contains information about the video, including its status (status
), the date and time it was created (createDateTime
), the date and time it was last updated (lastChangedDateTime
), and other properties specific to the video.The status property indicates the current status of the video, which can be :
done
(indicating that the video is complete)failed
(indicating that an error occurred during video creation)in_progress
(indicating that the video is still being created)Other properties returned by the endpoint include:
generated_from
(which indicates the method used to create the video (FORM, URL, or PRODUCT)identifier
(which is a unique identifier for the video.)Additionally, the JSON object contains links to the un-watermarked version of the video (
un_wateremark_link
) and a thumbnail image for the video (thumbnail
). The website
property is only shown if the video was generated through the URL
mode.HTTP Request
GET https://api.oxolo.com/v1/api/videos/{VIDEO_IDENTIFIER}
curl -X 'GET'
'https://api.oxolo.com/v1/api/videos/{VIDEO_IDENTIFIER}'
-H 'accept: application/json'
-H 'authorization: YOUR_API_KEY'
{
"results": {
"isActive": true,
"createDateTime": "{VIDEO_CREATION_TIME}",
"createdBy": null,
"lastChangedDateTime": "{VIDEO_UPDATE_TIME}",
"lastChangedBy": null,
"internalComment": null,
"isVerified": false,
"website": null,
"identifier": "{VIDEO_IDENTIFIER}",
"generation_id": "{VIDEO_GENERATION_ID}",
"generated_from": "{VIDEO_STATE}",
"status": "VIDEO_STATUS}",
"progress": "{VIDEO_PROGRESS}",
"remainingTime": "{VIDEO_PROCESS_REMAINING_TIME}",
"stagText": "{VIDEO_STAGE_TEXT}",
"thumbnail": "{VIDEO_THUMBNAIL}",
"is_updating": false,
"show_popup": false,
"delete_at": null,
"generated_from": "{VIDEO_MODE}",
"s3_vtt_path": "{VIDEO_VTT_LINK}",
"batch_id": null,
"duration": "{VIDEO_DURATION}",
"title": "{VIDEO_TITLE}",
"un_wateremark_link": "{VIDEO_LINK}", //(Will deprecate in next version. prefer to use 'video_link')
"video_link": "{VIDEO_LINK}",
"target_platform": "{VIDEO_TARGET_PLATFORM}",
"target_language": "{VIDEO_TARGET_LANGUAGE}"
}
}