API ReferenceUpload videos

Retrieve a video indexing task

This method retrieves a video indexing task.

Path parameters

task_idstringRequired
The unique identifier of the video indexing task to retrieve.

Headers

x-api-keystringRequired

Response

The specified video indexing task has successfully been retrieved.
_idstring or null
A string representing the unique identifier of the task. It is assigned by the platform when a new task is created.
created_atstring or null

A string indicating the date and time, in the RFC RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), that the task was created.

hlsobject or null

The platform returns this object only for the videos that you uploaded with the enable_video_stream parameter set to true.

index_idstring or null
A string representing the unique identifier of the index to which the video must be uploaded.
statusstring or null

A string indicating the status of the video indexing task. See the Task object page for a list of possible statuses.

system_metadataobject or null

System-generated metadata about the video.

updated_atstring or null

A string indicating the date and time, in the RFC RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), that the task object was last updated. The platform updates this field every time the video indexing task transitions to a different state.

video_idstring or null
A string representing the unique identifier of the video associated with the specified video indexing task.

Errors