Manage engines

The Resources.Engine class provides methods to manage the video understanding engines available in your account.

Methods

Retrieve an engine

Description: This method retrieves an engine.

Function signature and example:

1async retrieve(id: string, options: RequestOptions = {}): Promise<Models.Engine>`

Parameters:

NameTypeRequiredDescription
idstringYesThe unique identifier of the engine to retrieve.
optionsRequestOptionsNoAdditional options for the request. Defaults to {}.

Return value: Returns a Promise that resolves to a Models.Engine instance.

API Reference: For a description of each field in the request and response, see the Retrieve an engine page.

List engines

Description: This method lists all the video understanding engines that are available in your account.

Function signature and example:

1async list(options: RequestOptions = {}): Promise<Models.Engine[]>

Parameters:

NameTypeRequiredDescription
optionsRequestOptionsNoAdditional options for the request. Defaults to {}.

Return value: Returns a Promise that resolves to an array of Models.Engine instances.

API Reference: For a description of each field in the request and response, see the List engines page.

Built with