Retrieve video information

GET

This method retrieves information about the specified video.

Path parameters

index-idstringRequired

The unique identifier of the index to which the video has been uploaded.

video-idstringRequired

The unique identifier of the video to retrieve.

Query parameters

embedbooleanOptionalDefaults to false

Set this parameter to true to retrieve the video embedding in the response. The video must be indexed with the Marengo video understanding model version 2.7 or later. For details on enabling this model for an index, see the Create an index page.

Response

The specified video information has successfully been retrieved.

_idstringOptional

The unique identifier of the video.

created_atstringOptional

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

updated_atstringOptional

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

indexed_atstringOptional

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

system_metadataobjectOptional

System-generated metadata about the video.

hlsobjectOptional

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

embeddingobjectOptional

Contains the embedding and the associated information. The platform returns this field when the embed query parameter is set to true in the request.

Errors

Built with