Sign in

v3

latestOpenAPI 3.1.02026-07-3197486526.1 KB
indexes > videos

Retrieve video information

<Info> This method will be deprecated in a future version. New implementations should use the Retrieve an indexed asset method.</Info>

This method retrieves information about the specified video.

get/indexes/{index-id}/videos/{video-id}

Path parameters

index-idstring required

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

video-idstring required

The unique identifier of the video to retrieve.

Query parameters

embedding_optionIndexesIndexIdVideosVideoIdGetParametersEmbeddingOptionSchemaItems[]

Specifies which types of embeddings to retrieve. Values: visual, audio, transcription. For details, see the Embedding options section.

<Note title="Note"> To retrieve embeddings for a video, it must be indexed using the Marengo video understanding model. For details on enabling this model for an index, see the [Create an index](/reference/create-index) page. </Note>
transcriptionboolean

The parameter indicates whether to retrieve a transcription of the spoken words for the indexed video.

Headers

x-api-keystring required

Your API key.

<Note title="Note"> You can find your API key on the <a href="https://playground.twelvelabs.io/dashboard/api-keys" target="_blank">API Keys</a> page. </Note>

Response

The specified video information has successfully been retrieved.

_idstring

The unique identifier of the video.

asset_idstring

The unique identifier of the associated asset.

created_atstring

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_atstring

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_atstring

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.

user_metadataUserMetadata

Metadata that helps you categorize your assets. The object contains user-defined keys and values, where keys are strings and values are one of string, integer, float, or boolean.

Example:

"user_metadata": {
  "category": "recentlyAdded",
  "batchNumber": 5,
  "rating": 9.3,
  "needsReview": true
}
<Note title="Note"> To store other types of data, such as objects or arrays, convert your data into string values before sending it. </Note>