indexes > indexedAssets
Retrieve indexed asset information
This method retrieves information about an indexed asset, including its status, metadata, and optional embeddings or transcription.
Use this method to:
-
Monitor the indexing progress:
- Call this endpoint after creating an indexed asset
- Check the status field until it shows ready
- Once ready, your content is available for search and analysis
-
Retrieve the asset metadata:
- Retrieve system metadata (duration, resolution, filename)
- Access user-defined metadata
-
Retrieve the embeddings:
- Include the embeddingOption parameter to retrieve video embeddings
- Requires the Marengo video understanding model to be enabled in your index
-
Retrieve transcriptions:
- Set the transcription parameter to true to retrieve spoken words from your video
get/indexes/{index_id}/indexed-assets/{indexed_asset_id}
Request
- Base URLhttps://api.twelvelabs.io/v1.3
- AuthAPI key in header x-api-key
Path parameters
index_idstring required
The unique identifier of the index to which the indexed asset has been uploaded.
indexed_asset_idstring required
The unique identifier of the indexed asset to retrieve.
Query parameters
embedding_optionIndexes Index Id Indexed Assets Indexed Asset Id Get Parameters Embedding Option Schema Items[]
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
Specifies whether to retrieve a transcription of the spoken words.
Response
The specified indexed asset information has successfully been retrieved.
Changes
No recorded changes to this operation across all 33 revisions of this API.