v3

latestOpenAPI 3.1.02026-07-3197486526.1 KB

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}

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_optionIndexesIndexIdIndexedAssetsIndexedAssetIdGetParametersEmbeddingOptionSchemaItems[]

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.

Headers

x-api-keystring required

Your API key.

Response

The specified indexed asset information has successfully been retrieved.

_idstring

A string representing the unique identifier of your indexed asset.

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 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 indexing task was last updated. The platform updates this field every time the 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 indexing task has been completed.

status'ready' | 'pending' | 'queued' | 'indexing' | 'failed'

The status of the indexing task.

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>