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.

_idstringOptional

The unique identifier of the video indexing task.

created_atstringOptional

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

updated_atstringOptional

A string indicating the date and time, in the 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.

estimated_timestringOptional

A string indicating the estimated completion date and time of the video indexing process, in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”).

index_idstringOptional

A string representing the unique identifier of index to which the video is uploaded.

video_idstringOptional

A string representing the unique identifier of the video associated with the specified video indexing task. The API returns this field only when the value of the status field is ready.

statusstringOptional

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

metadataobjectOptional

An object that contains details about the video.

hlsobjectOptional

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

processobjectOptional

If your video has not yet finished indexing, the platform returns the current progress of the indexing operation.

Errors