The IndexesClient.IndexedAssetsClient class provides methods to manage indexed assets within an index.

Workflow

Before you begin, create an index if you don’t have one.

Methods

Index an asset

Description: This method indexes an uploaded asset to make it searchable and analyzable. Indexing processes your content and extracts information that enables the platform to search and analyze your videos.

This operation is asynchronous. The platform returns an indexed asset ID immediately and processes your content in the background. Monitor the indexing status to know when your content is ready to use.

Your asset must meet the requirements based on your workflow:

• Search: Marengo requirements
• Video analysis: Pegasus requirements

If you want to both search and analyze your videos, the most restrictive requirements apply.

Function signature and example:

1
def create(
2
    self,
3
    index_id: str,
4
    *,
5
    asset_id: str,
6
    enable_video_stream: typing.Optional[bool] = OMIT,
7
    request_options: typing.Optional[RequestOptions] = None,
8
) -> IndexedAssetsCreateResponse

Parameters:

Return value: Returns an IndexedAssetsCreateResponse object containing the unique identifier of the indexed asset.

The IndexedAssetsCreateResponse class contains the following properties:

API Reference: Index an asset

Retrieve an indexed asset

Description: 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 Function signature and example:

1
def retrieve(
2
    self,
3
    index_id: str,
4
    indexed_asset_id: str,
5
    *,
6
    embedding_option: typing.Optional[
7
        typing.Union[
8
            IndexedAssetsRetrieveRequestEmbeddingOptionItem,
9
            typing.Sequence[IndexedAssetsRetrieveRequestEmbeddingOptionItem],
10
        ]
11
    ] = None,
12
    transcription: typing.Optional[bool] = None,
13
    request_options: typing.Optional[RequestOptions] = None,
14
) -> IndexedAssetDetailed

Parameters:

Return value: Returns an IndexedAssetDetailed object containing detailed information about the indexed asset.

The IndexedAssetDetailed class extends IndexedAsset and contains the following additional properties:

The IndexedAssetDetailed class also inherits all properties from IndexedAsset:

The IndexedAssetSystemMetadata class contains the following properties:

The HlsObject class contains the following properties:

The TranscriptionDataItem class contains the following properties:

API Reference: Retrieve an indexed asset

Update an indexed asset

Description: This method updates one or more fields of the metadata of an indexed asset. You can also delete a field by setting it to null.

Function signature and example:

1
def update(
2
    self,
3
    index_id: str,
4
    indexed_asset_id: str,
5
    *,
6
    user_metadata: typing.Optional[UserMetadata] = OMIT,
7
    request_options: typing.Optional[RequestOptions] = None,
8
) -> None

Parameters:

Return value: Returns None.

API Reference: Update indexed asset

List indexed assets

Description: This method returns a list of the indexed assets in the specified index. By default, the platform returns your indexed assets sorted by creation date, with the newest at the top of the list.

Function signature and example:

1
def list(
2
    self,
3
    index_id: str,
4
    *,
5
    page: typing.Optional[int] = None,
6
    page_limit: typing.Optional[int] = None,
7
    sort_by: typing.Optional[str] = None,
8
    sort_option: typing.Optional[str] = None,
9
    status: typing.Optional[
10
        typing.Union[IndexedAssetsListRequestStatusItem, typing.Sequence[IndexedAssetsListRequestStatusItem]]
11
    ] = None,
12
    filename: typing.Optional[str] = None,
13
    duration: typing.Optional[float] = None,
14
    fps: typing.Optional[float] = None,
15
    width: typing.Optional[float] = None,
16
    height: typing.Optional[int] = None,
17
    size: typing.Optional[float] = None,
18
    created_at: typing.Optional[str] = None,
19
    updated_at: typing.Optional[str] = None,
20
    user_metadata: typing.Optional[
21
        typing.Dict[str, typing.Optional[IndexedAssetsListRequestUserMetadataValue]]
22
    ] = None,
23
    request_options: typing.Optional[RequestOptions] = None,
24
) -> SyncPager[IndexedAsset]

Parameters:

Return value: Returns a SyncPager[IndexedAsset] object that allows you to iterate through the paginated indexed asset results.

The SyncPager[T] class contains the following properties and methods:

The IndexedAsset class contains the following properties:

API Reference: List indexed assets

Delete an indexed asset

Description: This method deletes all the information about the specified indexed asset. This action cannot be undone.

Function signature and example:

1
def delete(
2
    self,
3
    index_id: str,
4
    indexed_asset_id: str,
5
    *,
6
    request_options: typing.Optional[RequestOptions] = None
7
) -> None

Parameters:

Return value: Returns None.

API Reference: Delete an indexed asset