API ReferenceManage videos

Retrieve video information

This method retrieves information about the specified video.

Important

When retrieving video embeddings, the response includes breaking changes that might require updates to your application code. Key differences:

  • The video_embeddings field has been renamed to video_embedding (plural to singular)
  • The embedding vectors are now nested under an array named segments.

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.

Headers

x-api-keystringRequired

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 engine version 2.6 or later. For details on enabling this engine for an index, see the Create an index page.

Default: false.

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.

metadataobjectOptional

An object that contains system-generated metadata about the video, such as duration, width, height, etc.

user_metadatamap from strings to anyOptional

An object that contains user-defined metadata for categorizing and organizing videos. The platform returns this field only when the video has user-defined metadata that you’ve set using the metadata parameter of the PUT method.

hlsobjectOptional

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

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