The AssetsClient class provides methods to upload your media files to the platform. This method creates an asset that you can use in different workflows.

Workflow

Methods

Create an asset

Description: This method creates an asset by uploading a file to the platform. Assets are media files that you can use in downstream workflows, including indexing, analyzing video content, and creating entities.

Supported content: Video, audio, and images.

Upload methods:

• Local file: Set the method parameter to direct and use the file parameter to specify the file.
• Publicly accessible URL: Set the method parameter to url and use the url parameter to specify the URL of your file.

File size: 200MB maximum for local file uploads, 4GB maximum for URL uploads.

Additional requirements depend on your workflow:

• Search: Marengo requirements
• Video analysis: Pegasus requirements
• Entity search: Marengo image requirements
• Create embeddings: Marengo requirements

Function signature and example:

1
def create(
2
    self,
3
    *,
4
    method: AssetsCreateRequestMethod,
5
    file: typing.Optional[core.File] = OMIT,
6
    url: typing.Optional[str] = OMIT,
7
    filename: typing.Optional[str] = OMIT,
8
    request_options: typing.Optional[RequestOptions] = None,
9
) -> Asset

Parameters:

Return value: Returns an object of type Asset representing the created asset.

The Asset class contains the following properties:

API Reference: Create an asset

List assets

Description: This method returns a list of assets in your account.

The platform returns your assets sorted by creation date, with the newest at the top of the list.

Function signature and example:

1
def list(
2
    self,
3
    *,
4
    page: typing.Optional[int] = None,
5
    page_limit: typing.Optional[int] = None,
6
    asset_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
7
    asset_types: typing.Optional[
8
        typing.Union[AssetsListRequestAssetTypesItem, typing.Sequence[AssetsListRequestAssetTypesItem]]
9
    ] = None,
10
    request_options: typing.Optional[RequestOptions] = None,
11
) -> SyncPager[Asset]

Parameters:

Return value: Returns a SyncPager[Asset] object containing a paginated list of Asset objects, representing the assets that match the specified criteria. For details about the Asset class see the Create an asset section above.

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

API Reference: List assets

Retrieve an asset

Description: This method retrieves details about the specified asset.

Function signature and example:

1
def retrieve(
2
    self,
3
    asset_id: str,
4
    *,
5
    request_options: typing.Optional[RequestOptions] = None
6
) -> Asset

Parameters:

Return value: Returns an Asset object containing details about the specified asset. For details about the Asset class, see the Create an asset section above.

API Reference: Retrieve an asset

Delete an asset

Description: This method deletes the specified asset. This action cannot be undone.

Function signature and example:

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

Parameters:

Return value: Returns None.

API Reference: Delete asset