Retrieve video information
This method retrieves information about the specified video.
Path parameters
The unique identifier of the index to which the video has been uploaded.
The unique identifier of the video to retrieve.
Headers
Query parameters
Specifies which types of embeddings to retrieve. You can include one or more of the following values:
visual-text
: Returns visual embeddings optimized for text search.audio
: Returns audio embeddings.
Notes
- To retrieve video embeddings, the video must be indexed using Marengo video understanding model version 2.7 or later. For details on enabling this model for an index, see the Create an index page. The platform does not return embeddings if you omit this parameter.
- The values you specify in
embedding_option
must be included in themodel_options
defined when the index was created. For example, ifmodel_options
is set tovisual,
you cannot setembedding_option
toaudio
or bothvisual-text
andaudio
.
Response
The specified video information has successfully been retrieved.
The unique identifier of the video.
A string indicating the date and time, in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), that the video indexing task was created.
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.
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-generated metadata about the video.
The platform returns this object only for the videos that you uploaded with the enable_video_stream
parameter set to true
.
Contains the embedding and the associated information. The platform returns this field when the embedding_option
parameter is specified in the request.